@guardian/ophan-tracker-js 2.1.1 → 2.1.2-next.0

package/assets/privatebrowsing.js

@@ -1,71 +0,0 @@
-import transmit from './transmit.js';
-
-/*
-	TO-DO:
-	This function could probably be simplified with an async function.
-	It basically returns a `boolean`, but uses a callback to do so... I can only guess it’s because of [`requestFileSystem`’s signature](https://developer.mozilla.org/en-US/docs/Web/API/Window/requestFileSystem).
- */
-const privateBrowsingMode = (callback) => {
-	const reportNormalMode = () => callback(false);
-	const reportPrivateMode = () => callback(true);
-
-	const tryLocalStorage = () => {
-		try {
-			if (localStorage.length) {
-				reportNormalMode();
-			} else {
-				localStorage.x = 1;
-				localStorage.removeItem('x');
-				reportNormalMode();
-			}
-		} catch (error) {
-			reportPrivateMode();
-		}
-	};
-
-	const tryIndexedDB = () => {
-		try {
-			const db = indexedDB.open('test');
-			db.onsuccess = reportNormalMode;
-			db.onerror = reportPrivateMode;
-		} catch (error) {
-			reportPrivateMode();
-		}
-	};
-
-	// Blink
-	if (window.webkitRequestFileSystem) {
-		window.webkitRequestFileSystem(
-			window.TEMPORARY,
-			1,
-			reportNormalMode,
-			reportPrivateMode,
-		);
-		// Firefox
-	} else if ('MozAppearance' in document.documentElement.style) {
-		tryIndexedDB();
-		// Safari
-	} else if (/constructor/i.test(window.HTMLElement)) {
-		tryLocalStorage();
-	} else if (
-		!window.indexedDB &&
-		(window.PointerEvent || window.MSPointerEvent)
-	) {
-		reportPrivateMode();
-	} else {
-		// Rest
-		reportNormalMode();
-	}
-};
-
-export default {
-	init() {
-		privateBrowsingMode((value) => {
-			const report = {
-				inPrivateBrowsingMode: value,
-			};
-			transmit.sendMore(report);
-		});
-	},
-	privateBrowsingMode,
-};

package/assets/r2.js

@@ -1,24 +0,0 @@
-// 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,
-};

package/assets/smart-news.js

@@ -1,19 +0,0 @@
-// 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';
-
-core.init('smart-news');
-
-if (window.addEventListener != null) {
-	attention.init(visibility);
-}
-
-export default {
-	record: transmit.sendMore,
-	viewId: transmit.viewId,
-};

package/assets/support.js

@@ -1,34 +0,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';
-
-const init = () => {
-	core.init('support');
-	if (window.addEventListener) {
-		attention.init(visibility);
-	}
-};
-
-const sendInitialEvent = (
-	url = location.href,
-	referrer = document.referrer,
-) => {
-	try {
-		transmit.bumpViewId();
-		core.sendInitialEvent(null, url, referrer);
-	} catch (error) {
-		console.log(error);
-	}
-};
-
-export default {
-	init,
-	sendInitialEvent,
-	record: transmit.sendMore,
-	viewId: transmit.viewId,
-};

package/assets/transmit.js

@@ -1,143 +0,0 @@
-const ophanRemoteHost = window?.ophanRemoteHost || 'https://ophan.theguardian.com';
-
-/**
- * @returns {string}
- */
-const generatePageViewId = () => {
-	return `${new Date().getTime().toString(36)}${'xxxxxxxxxxxx'.replace(
-		/x/g,
-		() => Math.floor(Math.random() * 36).toString(36),
-	)}`;
-};
-
-//  guardian.config.ophan.pageViewId is now pregenerated in
-//  the Guardian Frontend Project (https://github.com/guardian/frontend)
-//  frontend/common/app/templates/inlineJS/blocking/config.scala.js
-//  If you're going to change the generation method, please update that one too
-let viewId;
-if (typeof guardian !== 'undefined') {
-	viewId = guardian.config?.ophan?.pageViewId ?? generatePageViewId();
-} else {
-	viewId = generatePageViewId();
-}
-
-const bumpViewId = () => {
-	viewId = generatePageViewId();
-};
-
-/**
- * send the initial event associated with this page view
- * store the resulting page view id
- * this must only ever be called *once* subsequent calls will
- * be ignored
- * @param {Object} obj - The data to be sent.
- */
-const sendInitial = (obj) => {
-	send(`${ophanRemoteHost}/img/1?${buildQueryString(obj)}`);
-};
-
-/**
- * Encodes a value for URL transmission.
- * @param {(string|number)} value - The value to encode.
- * @returns {string} The encoded value.
- */
-const smartEncode = (value) => {
-	if (typeof value === 'string' || typeof value === 'number') {
-		return encodeURIComponent(value);
-	} else {
-		return encodeURIComponent(JSON.stringify(value));
-	}
-};
-
-/**
- * Used for sending additional events after the initial PageView event has been sent, such as attention events.
- * @param {Object} obj - The data object to be sent.
- * @param {Function} [f] - An optional callback function. This is used by consumers of this library.
- */
-const sendMore = (obj, f) => {
-	if (!JSON) return;
-
-	const values = [];
-	for (const prop in obj) {
-		if (obj.hasOwnProperty(prop) && isDefined(obj[prop])) {
-			values.push(`${encodeURIComponent(prop)}=${smartEncode(obj[prop])}`);
-		}
-	}
-
-	if (values.length === 0) {
-		return;
-	}
-
-	const url = `${ophanRemoteHost}/img/2?viewId=${viewId}&${values.join('&')}`;
-	send(url, f);
-};
-
-/**
- * Checks if a value is defined and not null.
- * @param {*} v - The value to check.
- * @returns {boolean} True if the value is defined, false otherwise.
- */
-const isDefined = (v) => {
-	if (Array.isArray(v)) {
-		return !!v.length;
-	} else {
-		return v != null;
-	}
-};
-
-/**
- * Builds a query string from an object.
- * @param {Object} obj - The object to convert to a query string.
- * @returns {string} The resulting query string.
- */
-const buildQueryString = (obj) => {
-	obj.viewId = viewId;
-
-	const values = [];
-	for (const prop in obj) {
-		if (obj.hasOwnProperty(prop) && obj[prop] != null) {
-			values.push(`${encodeURIComponent(prop)}=${encodeURIComponent(obj[prop])}`);
-		}
-	}
-
-	return values.join('&');
-};
-
-/**
- * Sends data to a specified URL, i.e.: the Ophan Tracker backend service.
- * @param {string} url - The URL to send data to.
- * @param {() => void} [f] - An optional callback function.
- */
-const send = (url, f) => {
-	if (typeof fetch === 'function') {
-		return fetch(url, { method: 'GET', mode: 'no-cors', keepalive: true, credentials: "include" }).then(() => f?.());
-	} else {
-		const image = new Image();
-		const checker = setInterval(() => {
-			if (image.complete) {
-				if (typeof f === 'function') {
-					f();
-				}
-				clearInterval(checker);
-			}
-		}, 10);
-		image.src = url;
-	}
-};
-
-export default {
-	sendInitial,
-	sendMore,
-	viewId,
-	bumpViewId,
-};
-
-/**
- * Exports for testing purposes.
- */
-export const _testExports = {
-	generatePageViewId,
-	smartEncode,
-	isDefined,
-	buildQueryString,
-};

package/assets/vendor/adBlockDetectionLib.js

@@ -1,366 +0,0 @@
-// Generated by CoffeeScript 2.7.0
-// TLDR; This is stripped down from the IAB ad block detection library.
-// https://github.com/InteractiveAdvertisingBureau/AdBlockDetection
-// The aforementioned library is not well maintained
-// and had work in progress network adblocking detection
-
-var init = function () {
-	var ofs = 'offset',
-		cl = 'client';
-	var noop = function () {};
-
-	var testedOnce = false;
-	var testExecuting = false;
-
-	var isOldIEevents = window.addEventListener === undefined;
-
-	/**
-	 * Options set with default options initialized
-	 *
-	 */
-	var _options = {
-		loopDelay: 50,
-		maxLoop: 5,
-		debug: false,
-		found: noop,
-		notfound: noop,
-		complete: noop,
-	};
-
-	var listeners = []; // event response listeners
-	var baitNode = null;
-	var quickBait = {
-		cssClass:
-			'ad-slot pub_300x250 pub_300x250m pub_728x90 text-ad textAd text_ad text_ads text-ads text-ad-links',
-	};
-	var baitTriggers = {
-		nullProps: [ofs + 'Parent'],
-		zeroProps: [],
-	};
-
-	baitTriggers.zeroProps = [
-		ofs + 'Height',
-		ofs + 'Left',
-		ofs + 'Top',
-		ofs + 'Width',
-		ofs + 'Height',
-		cl + 'Height',
-		cl + 'Width',
-	];
-
-	// result object
-	var exeResult = {
-		quick: null,
-		remote: null,
-	};
-
-	var findResult = null; // result of test for ad blocker
-
-	var timerIds = {
-		test: 0,
-		download: 0,
-	};
-
-	function isFunc(fn) {
-		return typeof fn == 'function';
-	}
-
-	/**
-	 * Make a DOM element
-	 */
-	function makeEl(tag, attributes) {
-		var k,
-			v,
-			el,
-			attr = attributes;
-		var d = document;
-
-		el = d.createElement(tag);
-
-		if (attr) {
-			for (k in attr) {
-				if (attr.hasOwnProperty(k)) {
-					el.setAttribute(k, attr[k]);
-				}
-			}
-		}
-
-		return el;
-	}
-
-	function attachEventListener(dom, eventName, handler) {
-		if (isOldIEevents) {
-			dom.attachEvent('on' + eventName, handler);
-		} else {
-			dom.addEventListener(eventName, handler, false);
-		}
-	}
-
-	function log(message, isError) {
-		if (!_options.debug && !isError) {
-			return;
-		}
-		if (window.console && window.console.log) {
-			if (isError) {
-				console.error('[ABD] ' + message);
-			} else {
-				console.log('[ABD] ' + message);
-			}
-		}
-	}
-
-	function beginTest(bait) {
-		log('start beginTest');
-		if (findResult == true) {
-			return;
-		}
-		testExecuting = true;
-		castBait(bait);
-
-		exeResult.quick = 'testing';
-
-		timerIds.test = setTimeout(function () {
-			reelIn(bait, 1);
-		}, 5);
-	}
-
-	/**
-	 * Create the bait node to see how the browser page reacts
-	 */
-	function castBait(bait) {
-		var i,
-			d = document,
-			b = d.body;
-		var t;
-		var baitStyle =
-			'width: 1px !important; height: 1px !important; position: absolute !important; left: -10000px !important; top: -1000px !important;';
-
-		if (bait == null || typeof bait == 'string') {
-			log('invalid bait being cast');
-			return;
-		}
-
-		if (bait.style != null) {
-			baitStyle += bait.style;
-		}
-
-		baitNode = makeEl('div', {
-			class: bait.cssClass,
-			style: baitStyle,
-		});
-
-		log('adding bait node to DOM');
-
-		b.appendChild(baitNode);
-
-		// touch these properties
-		for (i = 0; i < baitTriggers.nullProps.length; i++) {
-			t = baitNode[baitTriggers.nullProps[i]];
-		}
-		for (i = 0; i < baitTriggers.zeroProps.length; i++) {
-			t = baitNode[baitTriggers.zeroProps[i]];
-		}
-	}
-
-	/**
-	 * Run tests to see if browser has taken the bait and blocked the bait element
-	 */
-	function reelIn(bait, attemptNum) {
-		var i, k, v;
-		var body = document.body;
-		var found = false;
-
-		if (baitNode == null) {
-			log('recast bait');
-			castBait(bait || quickBait);
-		}
-
-		if (typeof bait == 'string') {
-			log('invalid bait used', true);
-			if (clearBaitNode()) {
-				setTimeout(function () {
-					testExecuting = false;
-				}, 5);
-			}
-
-			return;
-		}
-
-		if (timerIds.test > 0) {
-			clearTimeout(timerIds.test);
-			timerIds.test = 0;
-		}
-
-		// test for issues
-
-		if (body.getAttribute('abp') !== null) {
-			log('found adblock body attribute');
-			found = true;
-		}
-
-		for (i = 0; i < baitTriggers.nullProps.length; i++) {
-			if (baitNode[baitTriggers.nullProps[i]] == null) {
-				if (attemptNum > 4) found = true;
-				log('found adblock null attr: ' + baitTriggers.nullProps[i]);
-				break;
-			}
-			if (found == true) {
-				break;
-			}
-		}
-
-		for (i = 0; i < baitTriggers.zeroProps.length; i++) {
-			if (found == true) {
-				break;
-			}
-			if (baitNode[baitTriggers.zeroProps[i]] == 0) {
-				if (attemptNum > 4) found = true;
-				log('found adblock zero attr: ' + baitTriggers.zeroProps[i]);
-			}
-		}
-
-		if (window.getComputedStyle !== undefined) {
-			var baitTemp = window.getComputedStyle(baitNode, null);
-			if (
-				baitTemp.getPropertyValue('display') == 'none' ||
-				baitTemp.getPropertyValue('visibility') == 'hidden'
-			) {
-				if (attemptNum > 4) found = true;
-				log('found adblock computedStyle indicator');
-			}
-		}
-
-		testedOnce = true;
-
-		if (found || attemptNum++ >= _options.maxLoop) {
-			findResult = found;
-			log('exiting test loop - value: ' + findResult);
-			notifyListeners();
-			if (clearBaitNode()) {
-				setTimeout(function () {
-					testExecuting = false;
-				}, 5);
-			}
-		} else {
-			timerIds.test = setTimeout(function () {
-				reelIn(bait, attemptNum);
-			}, _options.loopDelay);
-		}
-	}
-
-	function clearBaitNode() {
-		if (baitNode === null) {
-			return true;
-		}
-
-		try {
-			if (isFunc(baitNode.remove)) {
-				baitNode.remove();
-			}
-			document.body.removeChild(baitNode);
-		} catch (ex) {}
-		baitNode = null;
-
-		return true;
-	}
-
-	/**
-	 * Halt the test and any pending timeouts
-	 */
-	function stopFishing() {
-		if (timerIds.test > 0) {
-			clearTimeout(timerIds.test);
-		}
-		if (timerIds.download > 0) {
-			clearTimeout(timerIds.download);
-		}
-
-		clearBaitNode();
-	}
-
-	/**
-	 * Fire all registered listeners
-	 */
-	function notifyListeners() {
-		var i, funcs;
-		if (findResult === null) {
-			return;
-		}
-		for (i = 0; i < listeners.length; i++) {
-			funcs = listeners[i];
-			try {
-				if (funcs != null) {
-					if (isFunc(funcs['complete'])) {
-						funcs['complete'](findResult);
-					}
-
-					if (findResult && isFunc(funcs['found'])) {
-						funcs['found']();
-					} else if (findResult === false && isFunc(funcs['notfound'])) {
-						funcs['notfound']();
-					}
-				}
-			} catch (ex) {
-				log('Failure in notify listeners ' + ex.Message, true);
-			}
-		}
-	}
-
-	/**
-	 * Attaches event listener or fires if events have already passed.
-	 */
-	function attachOrFire() {
-		var fireNow = false;
-		var fn;
-
-		if (document.readyState) {
-			if (document.readyState == 'complete') {
-				fireNow = true;
-			}
-		}
-
-		fn = function () {
-			beginTest(quickBait, false);
-		};
-
-		if (fireNow) {
-			fn();
-		} else {
-			attachEventListener(window, 'load', fn);
-		}
-	}
-
-	/**
-	 * Public interface of adblock detector
-	 */
-	return function (options) {
-		var k, v, funcs;
-
-		if (!options) {
-			return;
-		}
-
-		funcs = {
-			complete: noop,
-			found: noop,
-			notfound: noop,
-		};
-
-		for (k in options) {
-			if (options.hasOwnProperty(k)) {
-				if (k == 'complete' || k == 'found' || k == 'notFound') {
-					funcs[k.toLowerCase()] = options[k];
-				} else {
-					_options[k] = options[k];
-				}
-			}
-		}
-
-		listeners.push(funcs);
-
-		attachOrFire();
-	};
-};
-export default {
-	init: init(),
-};

package/assets/visibility.js

@@ -1,23 +0,0 @@
-export default {
-	state: () =>
-		document.visibilityState ||
-		document.webkitVisibilityState ||
-		document.mozVisibilityState ||
-		document.msVisibilityState,
-
-	changeEvent: getChangeEvent(),
-
-};
-
-function getChangeEvent() {
-	if (document.visibilityState) {
-		return 'visibilitychange';
-	} else if (document.webkitVisibilityState) {
-		return 'webkitvisibilitychange';
-	} else if (document.mozVisibilityState) {
-		return 'mozvisibilitychange';
-	} else if (document.msVisibilityState) {
-		return 'msvisibilitychange';
-	}
-	return undefined;
-}

package/assets/witness.js

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