@guardian/ophan-tracker-js 2.0.3

package/build/core.js

@@ -0,0 +1,234 @@
+// Generated by CoffeeScript 2.7.0
+
+/*
+Using an old-fashioned way of finding a query param rather than using searchParams
+as we don't control which environments the CDN distribution is being used in and so don't know if it's supported.
+*/
+var MaximumComponentNameLength, VERSION, appendComponentDataToEvent, appendContentType, appendDataFromLocalStorageToEvent, canStoreEventsInLocalStorage, doc, getNavigationType, getQueryParameterValue, getReferrer, init, onLoadCapture, onLoadCaptures, platform, sendInitialEvent, storeDataToSendOnNextEvent, trimComponentNamesToUrlSafeLength,
+  hasProp = {}.hasOwnProperty;
+
+import transmit from './transmit.js';
+
+import visibility from './visibility.js';
+
+import adblockDetection from './adblock-detection.js';
+
+VERSION = 17;
+
+doc = window.document;
+
+canStoreEventsInLocalStorage = (window.localStorage != null) && (typeof JSON !== "undefined" && JSON !== null);
+
+platform = null;
+
+MaximumComponentNameLength = 50;
+
+init = function(servingPlatform, httpStatus) {
+  platform = servingPlatform;
+  if (visibility.state() !== 'prerender') {
+    return sendInitialEvent(httpStatus);
+  } else {
+    if (visibility.changeEvent) {
+      return doc.addEventListener(visibility.changeEvent, (function() {
+        if (visibility.state() === "visible") {
+          return sendInitialEvent(httpStatus);
+        }
+      }), false);
+    }
+  }
+};
+
+getQueryParameterValue = function(paramName) {
+  var i, keyValue, len, param, queryParams, queryString;
+  queryString = window.location.search.substring(1);
+  queryParams = queryString.split('&');
+  for (i = 0, len = queryParams.length; i < len; i++) {
+    param = queryParams[i];
+    keyValue = param.split('=');
+    if (keyValue[0] === paramName) {
+      return decodeURIComponent(keyValue[1]);
+    }
+  }
+};
+
+getReferrer = function(referrer) {
+  var ref;
+  if (referrer) {
+    return referrer;
+  } else {
+    /*
+    If an authentication flow takes place on page load, the referrer is lost.
+    So, if no referrer, fall back to query param holding the value of the referrer before the auth flow began.
+    See
+    https://github.com/guardian/support-frontend/blob/main/support-frontend/app/controllers/AuthCodeFlowController.scala#L105
+    for an example use.
+    */
+    return (ref = getQueryParameterValue('pre-auth-ref')) != null ? ref : '';
+  }
+};
+
+getNavigationType = function() {
+  var entries, ref;
+  if (((ref = window.performance) != null ? ref.getEntriesByType : void 0) != null) {
+    entries = window.performance.getEntriesByType("navigation");
+    if (entries.length > 0) {
+      return entries[0].type;
+    }
+  }
+  return null;
+};
+
+sendInitialEvent = function(httpStatus, url = location.href, referrer = window.document.referrer) {
+  var event, navigationType;
+  navigationType = getNavigationType();
+  // send initial event
+  event = {
+    v: VERSION,
+    platform: platform,
+    url: url,
+    ref: getReferrer(referrer),
+    visibilityState: visibility.state(),
+    isModernBrowser: typeof guardian !== "undefined" && guardian !== null ? guardian.isModernBrowser : void 0,
+    httpStatus: httpStatus,
+    tz: new Date().getTimezoneOffset()
+  };
+  if (navigationType != null) {
+    // Add navigation type as metadata to the event if it's not null
+    event.navigationType = navigationType;
+  }
+  appendContentType(event);
+  appendDataFromLocalStorageToEvent(event);
+  transmit.sendInitial(event);
+  return adblockDetection.run().then(function(adBlockerEnabled) {
+    // `adUnitWasHidden` is the query param used
+    // by the previous adblock detection, hence reusing it here.
+    return transmit.sendMore({
+      adUnitWasHidden: adBlockerEnabled
+    });
+  });
+};
+
+onLoadCaptures = [];
+
+onLoadCapture = function(dataCapture) {
+  var d, key, msg, val;
+  if (document.readyState === 'complete') {
+    msg = {};
+    d = dataCapture();
+    for (key in d) {
+      val = d[key];
+      msg[key] = val;
+    }
+    return transmit.sendMore(msg);
+  } else {
+    return onLoadCaptures.push(dataCapture);
+  }
+};
+
+if (typeof window.addEventListener === "function") {
+  window.addEventListener('load', function() {
+    var capture, d, i, key, len, msg, val;
+    msg = {};
+    for (i = 0, len = onLoadCaptures.length; i < len; i++) {
+      capture = onLoadCaptures[i];
+      d = capture();
+      for (key in d) {
+        val = d[key];
+        msg[key] = val;
+      }
+    }
+    if (platform === "next-gen") {
+      appendComponentDataToEvent(msg);
+    }
+    return transmit.sendMore(msg);
+  }, false);
+}
+
+appendDataFromLocalStorageToEvent = function(event) {
+  var key, localStorageItems, value;
+  if (canStoreEventsInLocalStorage) {
+    localStorageItems = JSON.parse(window.localStorage.getItem("ophan_follow"));
+    if (localStorageItems != null) {
+      for (key in localStorageItems) {
+        if (!hasProp.call(localStorageItems, key)) continue;
+        value = localStorageItems[key];
+        event[key] = value;
+      }
+    }
+    return window.localStorage.removeItem("ophan_follow");
+  }
+};
+
+trimComponentNamesToUrlSafeLength = function(componentNames) {
+  return componentNames.map(function(componentName) {
+    if (componentName.length > MaximumComponentNameLength) {
+      return componentName.substring(0, MaximumComponentNameLength).concat("…");
+    } else {
+      return componentName;
+    }
+  });
+};
+
+appendComponentDataToEvent = function(event) {
+  var componentNames, el, i, key, len, obj, trimmedComponentNames, value;
+  componentNames = (function() {
+    var i, len, ref, results;
+    ref = document.querySelectorAll('[data-component]');
+    results = [];
+    for (i = 0, len = ref.length; i < len; i++) {
+      el = ref[i];
+      results.push(el.getAttribute('data-component'));
+    }
+    return results;
+  })();
+  if (componentNames.length > 0) {
+    trimmedComponentNames = trimComponentNamesToUrlSafeLength(componentNames);
+    // uniquify
+    obj = {};
+    for (i = 0, len = trimmedComponentNames.length; i < len; i++) {
+      el = trimmedComponentNames[i];
+      (obj[el] = 1);
+    }
+    return event.renderedComponents = (function() {
+      var results;
+      results = [];
+      for (key in obj) {
+        value = obj[key];
+        results.push(key);
+      }
+      return results;
+    })();
+  }
+};
+
+storeDataToSendOnNextEvent = function(newData) {
+  var existingData, key, value;
+  if (canStoreEventsInLocalStorage) {
+    existingData = JSON.parse(window.localStorage.getItem("ophan_follow")) || {};
+    for (key in newData) {
+      if (!hasProp.call(newData, key)) continue;
+      value = newData[key];
+      existingData[key] = value;
+    }
+    return window.localStorage.setItem("ophan_follow", JSON.stringify(existingData));
+  }
+};
+
+appendContentType = function(event) {
+  var contentType, ref, ref1, ref2;
+  contentType = platform === "next-gen" || "embed" ? typeof guardian !== "undefined" && guardian !== null ? (ref = guardian.config) != null ? (ref1 = ref.page) != null ? ref1.contentType : void 0 : void 0 : void 0 : typeof guardian !== "undefined" && guardian !== null ? (ref2 = guardian.page) != null ? ref2.contentTypes : void 0 : void 0;
+  if ((contentType != null) && contentType !== "") {
+    return event.contentType = contentType.toLowerCase();
+  }
+};
+
+export default {
+  init: init,
+  storeDataToSendOnNextEvent: storeDataToSendOnNextEvent,
+  onLoadCapture: onLoadCapture,
+  servingPlatform: function() {
+    return platform;
+  },
+  viewId: transmit.viewId,
+  sendInitialEvent: sendInitialEvent
+};

package/build/embed.js

@@ -0,0 +1,11 @@
+// Generated by CoffeeScript 2.7.0
+import core from "./core.js";
+
+import transmit from "./transmit.js";
+
+core.init("embed");
+
+export default {
+  record: transmit.sendMore,
+  viewId: transmit.viewId
+};

package/build/fb-instant.js

@@ -0,0 +1,10 @@
+// Generated by CoffeeScript 2.7.0
+import core from "./core.js";
+
+import transmit from "./transmit.js";
+
+core.init("facebook-instant-article");
+
+export default {
+  viewId: transmit.viewId
+};

package/build/heatmap.js

@@ -0,0 +1,32 @@
+// Generated by CoffeeScript 2.7.0
+var heatmapFired, init;
+
+heatmapFired = false;
+
+init = function() {
+  var addHeatmap;
+  addHeatmap = function() {
+    var heatmapParam;
+    if ((typeof localStorage !== "undefined" && localStorage !== null) && !heatmapFired) {
+      heatmapFired = true;
+      heatmapParam = window.location.search.replace(/^(?:.*[&\?]heatmap(?:\=([^&]*))?)?.*$/, "$1");
+      if (heatmapParam === 'true' || heatmapParam === 'false') {
+        localStorage['ophan_heatmap'] = heatmapParam;
+      }
+      if (localStorage['ophan_heatmap'] === 'true' || heatmapParam === 'show') {
+        return document.body.appendChild(document.createElement('script')).src = '//dashboard.ophan.co.uk/assets/js/heatmap-bookmarklet.js';
+      }
+    }
+  };
+  if (document.readyState === 'complete') {
+    return addHeatmap();
+  } else {
+    return typeof window.addEventListener === "function" ? window.addEventListener('load', function() {
+      return addHeatmap();
+    }, false) : void 0;
+  }
+};
+
+export default {
+  init: init
+};

package/build/holidays.js

@@ -0,0 +1,11 @@
+// Generated by CoffeeScript 2.7.0
+import core from "./core.js";
+
+import transmit from "./transmit.js";
+
+core.init("holidays");
+
+export default {
+  record: transmit.sendMore,
+  viewId: transmit.viewId
+};

package/build/http-status.js

@@ -0,0 +1,20 @@
+// Generated by CoffeeScript 2.7.0
+var reportStatus;
+
+import core from "./core.js";
+
+import "./transmit.js";
+
+import "./click-path-capture.js";
+
+import "./perf.js";
+
+import "./campaign.js";
+
+reportStatus = function(platform, status) {
+  return core.init(platform, status);
+};
+
+export default {
+  reportStatus: reportStatus
+};

package/build/iframe-tracking.js

@@ -0,0 +1,68 @@
+// Generated by CoffeeScript 2.7.0
+var componentEventIsValid, handleIframeMessage, recordIframeClickEvent, recordIframeComponentEvent, retrieveOriginDomain, validIframeDomains;
+
+import clickCapture from "./click-path-capture.js";
+
+validIframeDomains = [
+  ".theguardian.com",
+  ".dev-theguardian.com",
+  ".thegulocal.com" // NB - leading dot is essential here to avoid matching on non-Guardian-owned domains
+];
+
+handleIframeMessage = function(messageEvent) {
+  var eventObject, iFrame, originDomain;
+  originDomain = retrieveOriginDomain(messageEvent.origin);
+  if (originDomain && validIframeDomains.some((domain) => {
+    return originDomain.endsWith(domain);
+  })) {
+    if (messageEvent.data.type === 'ophan-iframe-click-event') {
+      eventObject = messageEvent.data.value;
+      iFrame = document.getElementById(messageEvent.data.iframeId);
+      recordIframeClickEvent(iFrame, eventObject);
+    } else if (messageEvent.data.type === 'ophan-iframe-component-event') {
+      eventObject = messageEvent.data.value;
+      recordIframeComponentEvent(eventObject);
+    }
+  }
+};
+
+retrieveOriginDomain = function(eventOrigin) {
+  var e, originURL;
+  try {
+    originURL = new URL(eventOrigin);
+    return originURL.host;
+  } catch (error) {
+    e = error;
+    if (e instanceof TypeError) { // We failed to parse origin as an URL, we should ignore the event  
+      return null;
+    } else {
+      throw e;
+    }
+  }
+};
+
+recordIframeClickEvent = function(iFrame, clickEvent) {
+  if (iFrame) {
+    clickEvent.clickLinkNames = clickCapture.getDataLinkNames(iFrame, clickEvent.clickLinkNames) || clickEvent.clickLinkNames;
+  }
+  window.guardian.ophan.record(clickEvent);
+};
+
+componentEventIsValid = function(eventObject) {
+  if (!eventObject || typeof eventObject !== 'object') {
+    return false;
+  }
+  if (!eventObject.componentEvent || typeof eventObject.componentEvent !== 'object') {
+    return false;
+  }
+  return true;
+};
+
+recordIframeComponentEvent = function(eventObject) {
+  if (!componentEventIsValid(eventObject)) {
+    return;
+  }
+  window.guardian.ophan.record(eventObject);
+};
+
+window.addEventListener('message', handleIframeMessage, false);

package/build/interactive.js

@@ -0,0 +1,25 @@
+// Generated by CoffeeScript 2.7.0
+var ref;
+
+import core from "./core.js";
+
+import transmit from "./transmit.js";
+
+import attention from "./attention.js";
+
+import "./click-path-capture.js";
+
+if (((ref = window.guardian) != null ? ref.ophan : void 0) != null) {
+  window.guardian.ophan;
+} else {
+  core.init("embed");
+  if (window.guardian == null) {
+    window.guardian = {};
+  }
+  window.guardian.ophan = {
+    setEventEmitter: attention.setEventEmitter,
+    trackComponentAttention: attention.initComponent,
+    record: transmit.sendMore,
+    viewId: transmit.viewId
+  };
+}

package/build/jobs-courses.js

@@ -0,0 +1,11 @@
+// Generated by CoffeeScript 2.7.0
+import core from "./core.js";
+
+import transmit from "./transmit.js";
+
+core.init("jobs-courses");
+
+export default {
+  record: transmit.sendMore,
+  viewId: transmit.viewId
+};

package/build/jobs.js

@@ -0,0 +1,11 @@
+// Generated by CoffeeScript 2.7.0
+import core from "./core.js";
+
+import transmit from "./transmit.js";
+
+core.init("jobs");
+
+export default {
+  record: transmit.sendMore,
+  viewId: transmit.viewId
+};

package/build/manage-my-account.js

@@ -0,0 +1,47 @@
+// Generated by CoffeeScript 2.7.0
+var exports, sendInitialEvent;
+
+import core from "./core.js";
+
+import transmit from "./transmit.js";
+
+import attention from "./attention.js";
+
+import visibility from "./visibility.js";
+
+import "./click-path-capture.js";
+
+import "./perf.js";
+
+import "./campaign.js";
+
+core.init("manage-my-account");
+
+if (window.addEventListener != null) {
+  attention.init(visibility);
+}
+
+sendInitialEvent = function(url = location.href, referrer = window.document.referrer) {
+  var e;
+  try {
+    transmit.bumpViewId();
+    return core.sendInitialEvent(null, url, referrer);
+  } catch (error) {
+    e = error;
+    return console.log(e);
+  }
+};
+
+exports = {
+  sendInitialEvent: sendInitialEvent,
+  record: transmit.sendMore,
+  viewId: transmit.viewId
+};
+
+if (window.guardian == null) {
+  window.guardian = {};
+}
+
+window.guardian.ophan = exports;
+
+export default exports;

package/build/membership.js

@@ -0,0 +1,25 @@
+// Generated by CoffeeScript 2.7.0
+import core from "./core.js";
+
+import transmit from "./transmit.js";
+
+import attention from "./attention.js";
+
+import visibility from "./visibility.js";
+
+import "./click-path-capture.js";
+
+import "./perf.js";
+
+import "./campaign.js";
+
+core.init("membership");
+
+if (window.addEventListener != null) {
+  attention.init(visibility);
+}
+
+export default {
+  record: transmit.sendMore,
+  viewId: transmit.viewId
+};

package/build/ng.js

@@ -0,0 +1,33 @@
+// Generated by CoffeeScript 2.7.0
+var ng, ref;
+
+import core from "./core.js";
+
+import transmit from "./transmit.js";
+
+import attention from "./attention.js";
+
+import visibility from "./visibility.js";
+
+import privatebrowsing from "./privatebrowsing.js";
+
+import heatmap from "./heatmap.js";
+
+import "./click-path-capture.js";
+
+import "./perf.js";
+
+import "./iframe-tracking.js";
+
+// TODO:
+// pageViewId is used for Google Analytics on frontend, membership and some of the jobs sites.
+// If we can migrate these to use viewId instead then pageViewId can safely be removed
+ng = ((ref = window.guardian) != null ? ref.ophan : void 0) != null ? window.guardian.ophan : (core.init("next-gen"), privatebrowsing.init(), heatmap.init(), window.addEventListener != null ? attention.init(visibility) : void 0, window.guardian != null ? window.guardian : window.guardian = {}, window.guardian.ophan = {
+  setEventEmitter: attention.setEventEmitter,
+  trackComponentAttention: attention.initComponent,
+  record: transmit.sendMore,
+  viewId: transmit.viewId,
+  pageViewId: transmit.viewId
+});
+
+export default ng;

package/build/perf.js

@@ -0,0 +1,39 @@
+// Generated by CoffeeScript 2.7.0
+var perf, sendTimingData;
+
+import core from './core.js';
+
+perf = window.performance || window.msPerformance || window.webkitPerformance || window.mozPerformance;
+
+sendTimingData = function() {
+  var t;
+  t = perf != null ? perf.timing : void 0;
+  if (t != null) {
+    return {
+      performance: {
+        // Time required for domain lookup.
+        dns: t.domainLookupEnd - t.domainLookupStart,
+        // Time to establish a connection to server.
+        connection: t.connectEnd - t.connectStart,
+        // From connection established to first byte of data.
+        firstByte: t.responseStart - t.connectEnd,
+        // First byte to last byte, or closed, including if from cache.
+        lastByte: t.responseEnd - t.responseStart,
+        // From last byte of doc to start of domContentLoaded
+        domContentLoadedEvent: t.domContentLoadedEventStart - t.responseEnd,
+        // domcontentLoaded to start of load event.
+        loadEvent: t.loadEventStart - t.domContentLoadedEventStart,
+        // click, back/forward, etc...
+        navType: perf.navigation.type,
+        // No. of redirects on current domain.
+        redirectCount: perf.navigation.redirectCount
+      }
+    };
+  } else {
+    return {};
+  }
+};
+
+core.onLoadCapture(sendTimingData);
+
+export default perf;

package/build/privatebrowsing.js

@@ -0,0 +1,71 @@
+// Generated by CoffeeScript 2.7.0
+// Check if a visitor is using private browsing mode (true or false)
+// User agent checking and browser mode checking based on: https://gist.github.com/cou929/7973956#gistcomment-1769682
+var privateBrowsingMode;
+
+import transmit from './transmit.js';
+
+privateBrowsingMode = function(callback) {
+  var reportNormalMode, reportPrivateMode, tryIndexedDB, tryLocalStorage;
+  reportNormalMode = function() {
+    return callback(false);
+  };
+  reportPrivateMode = function() {
+    return callback(true);
+  };
+  tryLocalStorage = function() {
+    var error;
+    try {
+      if (localStorage.length) {
+        return reportNormalMode();
+      } else {
+        localStorage.x = 1;
+        localStorage.removeItem('x');
+        return reportNormalMode();
+      }
+    } catch (error1) {
+      error = error1;
+      return reportPrivateMode();
+    }
+  };
+  tryIndexedDB = function() {
+    var db, error;
+    try {
+      db = indexedDB.open('test');
+      db.onsuccess = reportNormalMode;
+      return db.onerror = reportPrivateMode;
+    } catch (error1) {
+      error = error1;
+      return reportPrivateMode();
+    }
+  };
+  
+  // Blink
+  if (window.webkitRequestFileSystem) {
+    return window.webkitRequestFileSystem(window.TEMPORARY, 1, reportNormalMode, reportPrivateMode);
+  // Firefox
+  } else if ('MozAppearance' in document.documentElement.style) {
+    return tryIndexedDB();
+  // Safari
+  } else if (/constructor/i.test(window.HTMLElement)) {
+    return tryLocalStorage();
+  } else if (!window.indexedDB && (window.PointerEvent || window.MSPointerEvent)) {
+    return reportPrivateMode();
+  } else {
+    // Rest
+    return reportNormalMode();
+  }
+};
+
+export default {
+  init: function() {
+    return privateBrowsingMode(function(value) {
+      var report;
+      report = {
+        inPrivateBrowsingMode: value
+      };
+      return transmit.sendMore(report);
+    });
+  },
+  privateBrowsingMode: privateBrowsingMode
+};

package/build/r2.js

@@ -0,0 +1,24 @@
+// Generated by CoffeeScript 2.7.0
+import core from './core.js';
+
+import transmit from './transmit.js';
+
+import attention from './attention.js';
+
+import visibility from './visibility.js';
+
+import './click-path-capture.js';
+
+import './perf.js';
+
+import './campaign.js';
+
+core.init("r2");
+
+if (window.addEventListener != null) {
+  attention.init(visibility);
+}
+
+export default {
+  viewId: transmit.viewId
+};