Sessions (#412)
* git ignore build
* Add http/browser session
* Add doc strings to backgound.js
* ignore nonexistent build when cleaning
diff --git a/.gitignore b/.gitignore
index 140e2df..8d50f9a 100644
--- a/.gitignore
+++ b/.gitignore
@@ -4,4 +4,5 @@
/.git/*
npm-debug.log
DS_store
-cypress
\ No newline at end of file
+cypress
+/build/*
\ No newline at end of file
diff --git a/build/UserALEWebExtension/background.js b/build/UserALEWebExtension/background.js
deleted file mode 100644
index 5b7123b..0000000
--- a/build/UserALEWebExtension/background.js
+++ /dev/null
@@ -1,1263 +0,0 @@
-/*
-* Licensed to the Apache Software Foundation (ASF) under one or more
-* contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
-* The ASF licenses this file to You under the Apache License, Version 2.0
-* (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
-
-var prefix = 'USERALE_';
-var CONFIG_CHANGE = prefix + 'CONFIG_CHANGE';
-var ADD_LOG = prefix + 'ADD_LOG';
-
-function _typeof(o) {
- "@babel/helpers - typeof";
-
- return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) {
- return typeof o;
- } : function (o) {
- return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o;
- }, _typeof(o);
-}
-
-var version$1 = "2.4.0";
-
-/*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the 'License'); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an 'AS IS' BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-var sessionId = null;
-
-/**
- * Extracts the initial configuration settings from the
- * currently executing script tag.
- * @return {Object} The extracted configuration object
- */
-function getInitialSettings() {
- var settings = {};
- if (sessionId === null) {
- sessionId = getSessionId('userAleSessionId', 'session_' + String(Date.now()));
- }
- var script = document.currentScript || function () {
- var scripts = document.getElementsByTagName('script');
- return scripts[scripts.length - 1];
- }();
- var get = script ? script.getAttribute.bind(script) : function () {
- return null;
- };
- settings.autostart = get('data-autostart') === 'false' ? false : true;
- settings.url = get('data-url') || 'http://localhost:8000';
- settings.transmitInterval = +get('data-interval') || 5000;
- settings.logCountThreshold = +get('data-threshold') || 5;
- settings.userId = get('data-user') || null;
- settings.version = get('data-version') || null;
- settings.logDetails = get('data-log-details') === 'true' ? true : false;
- settings.resolution = +get('data-resolution') || 500;
- settings.toolName = get('data-tool') || null;
- settings.userFromParams = get('data-user-from-params') || null;
- settings.time = timeStampScale(document.createEvent('CustomEvent'));
- settings.sessionID = get('data-session') || sessionId;
- settings.authHeader = get('data-auth') || null;
- settings.custIndex = get('data-index') || null;
- settings.headers = get('data-headers') || null;
- return settings;
-}
-
-/**
- * defines sessionId, stores it in sessionStorage, checks to see if there is a sessionId in
- * storage when script is started. This prevents events like 'submit', which refresh page data
- * from refreshing the current user session
- *
- */
-function getSessionId(sessionKey, value) {
- if (window.sessionStorage.getItem(sessionKey) === null) {
- window.sessionStorage.setItem(sessionKey, JSON.stringify(value));
- return value;
- }
- return JSON.parse(window.sessionStorage.getItem(sessionKey));
-}
-
-/**
- * Creates a function to normalize the timestamp of the provided event.
- * @param {Object} e An event containing a timeStamp property.
- * @return {timeStampScale~tsScaler} The timestamp normalizing function.
- */
-function timeStampScale(e) {
- var tsScaler;
- if (e.timeStamp && e.timeStamp > 0) {
- var delta = Date.now() - e.timeStamp;
- /**
- * Returns a timestamp depending on various browser quirks.
- * @param {?Number} ts A timestamp to use for normalization.
- * @return {Number} A normalized timestamp.
- */
-
- if (delta < 0) {
- tsScaler = function tsScaler() {
- return e.timeStamp / 1000;
- };
- } else if (delta > e.timeStamp) {
- var navStart = performance.timing.navigationStart;
- tsScaler = function tsScaler(ts) {
- return ts + navStart;
- };
- } else {
- tsScaler = function tsScaler(ts) {
- return ts;
- };
- }
- } else {
- tsScaler = function tsScaler() {
- return Date.now();
- };
- }
- return tsScaler;
-}
-
-/*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-/**
- * Shallow merges the first argument with the second.
- * Retrieves/updates the userid if userFromParams is provided.
- * @param {Object} config Current configuration object to be merged into.
- * @param {Object} newConfig Configuration object to merge into the current config.
- */
-function configure(config, newConfig) {
- var configAutostart = config['autostart'];
- var newConfigAutostart = newConfig['autostart'];
- Object.keys(newConfig).forEach(function (option) {
- if (option === 'userFromParams') {
- var userId = getUserIdFromParams(newConfig[option]);
- if (userId) {
- config.userId = userId;
- }
- }
- config[option] = newConfig[option];
- });
- if (configAutostart === false || newConfigAutostart === false) {
- config['autostart'] = false;
- }
-}
-
-/**
- * Attempts to extract the userid from the query parameters of the URL.
- * @param {string} param The name of the query parameter containing the userid.
- * @return {string|null} The extracted/decoded userid, or null if none is found.
- */
-function getUserIdFromParams(param) {
- var userField = param;
- var regex = new RegExp('[?&]' + userField + '(=([^&#]*)|&|#|$)');
- var results = window.location.href.match(regex);
- if (results && results[2]) {
- return decodeURIComponent(results[2].replace(/\+/g, ' '));
- } else {
- return null;
- }
-}
-
-var __spreadArray = (undefined && undefined.__spreadArray) || function (to, from, pack) {
- if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
- if (ar || !(i in from)) {
- if (!ar) ar = Array.prototype.slice.call(from, 0, i);
- ar[i] = from[i];
- }
- }
- return to.concat(ar || Array.prototype.slice.call(from));
-};
-var BrowserInfo = /** @class */ (function () {
- function BrowserInfo(name, version, os) {
- this.name = name;
- this.version = version;
- this.os = os;
- this.type = 'browser';
- }
- return BrowserInfo;
-}());
-var NodeInfo = /** @class */ (function () {
- function NodeInfo(version) {
- this.version = version;
- this.type = 'node';
- this.name = 'node';
- this.os = process.platform;
- }
- return NodeInfo;
-}());
-var SearchBotDeviceInfo = /** @class */ (function () {
- function SearchBotDeviceInfo(name, version, os, bot) {
- this.name = name;
- this.version = version;
- this.os = os;
- this.bot = bot;
- this.type = 'bot-device';
- }
- return SearchBotDeviceInfo;
-}());
-var BotInfo = /** @class */ (function () {
- function BotInfo() {
- this.type = 'bot';
- this.bot = true; // NOTE: deprecated test name instead
- this.name = 'bot';
- this.version = null;
- this.os = null;
- }
- return BotInfo;
-}());
-var ReactNativeInfo = /** @class */ (function () {
- function ReactNativeInfo() {
- this.type = 'react-native';
- this.name = 'react-native';
- this.version = null;
- this.os = null;
- }
- return ReactNativeInfo;
-}());
-// tslint:disable-next-line:max-line-length
-var SEARCHBOX_UA_REGEX = /alexa|bot|crawl(er|ing)|facebookexternalhit|feedburner|google web preview|nagios|postrank|pingdom|slurp|spider|yahoo!|yandex/;
-var SEARCHBOT_OS_REGEX = /(nuhk|curl|Googlebot|Yammybot|Openbot|Slurp|MSNBot|Ask\ Jeeves\/Teoma|ia_archiver)/;
-var REQUIRED_VERSION_PARTS = 3;
-var userAgentRules = [
- ['aol', /AOLShield\/([0-9\._]+)/],
- ['edge', /Edge\/([0-9\._]+)/],
- ['edge-ios', /EdgiOS\/([0-9\._]+)/],
- ['yandexbrowser', /YaBrowser\/([0-9\._]+)/],
- ['kakaotalk', /KAKAOTALK\s([0-9\.]+)/],
- ['samsung', /SamsungBrowser\/([0-9\.]+)/],
- ['silk', /\bSilk\/([0-9._-]+)\b/],
- ['miui', /MiuiBrowser\/([0-9\.]+)$/],
- ['beaker', /BeakerBrowser\/([0-9\.]+)/],
- ['edge-chromium', /EdgA?\/([0-9\.]+)/],
- [
- 'chromium-webview',
- /(?!Chrom.*OPR)wv\).*Chrom(?:e|ium)\/([0-9\.]+)(:?\s|$)/,
- ],
- ['chrome', /(?!Chrom.*OPR)Chrom(?:e|ium)\/([0-9\.]+)(:?\s|$)/],
- ['phantomjs', /PhantomJS\/([0-9\.]+)(:?\s|$)/],
- ['crios', /CriOS\/([0-9\.]+)(:?\s|$)/],
- ['firefox', /Firefox\/([0-9\.]+)(?:\s|$)/],
- ['fxios', /FxiOS\/([0-9\.]+)/],
- ['opera-mini', /Opera Mini.*Version\/([0-9\.]+)/],
- ['opera', /Opera\/([0-9\.]+)(?:\s|$)/],
- ['opera', /OPR\/([0-9\.]+)(:?\s|$)/],
- ['pie', /^Microsoft Pocket Internet Explorer\/(\d+\.\d+)$/],
- ['pie', /^Mozilla\/\d\.\d+\s\(compatible;\s(?:MSP?IE|MSInternet Explorer) (\d+\.\d+);.*Windows CE.*\)$/],
- ['netfront', /^Mozilla\/\d\.\d+.*NetFront\/(\d.\d)/],
- ['ie', /Trident\/7\.0.*rv\:([0-9\.]+).*\).*Gecko$/],
- ['ie', /MSIE\s([0-9\.]+);.*Trident\/[4-7].0/],
- ['ie', /MSIE\s(7\.0)/],
- ['bb10', /BB10;\sTouch.*Version\/([0-9\.]+)/],
- ['android', /Android\s([0-9\.]+)/],
- ['ios', /Version\/([0-9\._]+).*Mobile.*Safari.*/],
- ['safari', /Version\/([0-9\._]+).*Safari/],
- ['facebook', /FB[AS]V\/([0-9\.]+)/],
- ['instagram', /Instagram\s([0-9\.]+)/],
- ['ios-webview', /AppleWebKit\/([0-9\.]+).*Mobile/],
- ['ios-webview', /AppleWebKit\/([0-9\.]+).*Gecko\)$/],
- ['curl', /^curl\/([0-9\.]+)$/],
- ['searchbot', SEARCHBOX_UA_REGEX],
-];
-var operatingSystemRules = [
- ['iOS', /iP(hone|od|ad)/],
- ['Android OS', /Android/],
- ['BlackBerry OS', /BlackBerry|BB10/],
- ['Windows Mobile', /IEMobile/],
- ['Amazon OS', /Kindle/],
- ['Windows 3.11', /Win16/],
- ['Windows 95', /(Windows 95)|(Win95)|(Windows_95)/],
- ['Windows 98', /(Windows 98)|(Win98)/],
- ['Windows 2000', /(Windows NT 5.0)|(Windows 2000)/],
- ['Windows XP', /(Windows NT 5.1)|(Windows XP)/],
- ['Windows Server 2003', /(Windows NT 5.2)/],
- ['Windows Vista', /(Windows NT 6.0)/],
- ['Windows 7', /(Windows NT 6.1)/],
- ['Windows 8', /(Windows NT 6.2)/],
- ['Windows 8.1', /(Windows NT 6.3)/],
- ['Windows 10', /(Windows NT 10.0)/],
- ['Windows ME', /Windows ME/],
- ['Windows CE', /Windows CE|WinCE|Microsoft Pocket Internet Explorer/],
- ['Open BSD', /OpenBSD/],
- ['Sun OS', /SunOS/],
- ['Chrome OS', /CrOS/],
- ['Linux', /(Linux)|(X11)/],
- ['Mac OS', /(Mac_PowerPC)|(Macintosh)/],
- ['QNX', /QNX/],
- ['BeOS', /BeOS/],
- ['OS/2', /OS\/2/],
-];
-function detect(userAgent) {
- if (!!userAgent) {
- return parseUserAgent(userAgent);
- }
- if (typeof document === 'undefined' &&
- typeof navigator !== 'undefined' &&
- navigator.product === 'ReactNative') {
- return new ReactNativeInfo();
- }
- if (typeof navigator !== 'undefined') {
- return parseUserAgent(navigator.userAgent);
- }
- return getNodeVersion();
-}
-function matchUserAgent(ua) {
- // opted for using reduce here rather than Array#first with a regex.test call
- // this is primarily because using the reduce we only perform the regex
- // execution once rather than once for the test and for the exec again below
- // probably something that needs to be benchmarked though
- return (ua !== '' &&
- userAgentRules.reduce(function (matched, _a) {
- var browser = _a[0], regex = _a[1];
- if (matched) {
- return matched;
- }
- var uaMatch = regex.exec(ua);
- return !!uaMatch && [browser, uaMatch];
- }, false));
-}
-function parseUserAgent(ua) {
- var matchedRule = matchUserAgent(ua);
- if (!matchedRule) {
- return null;
- }
- var name = matchedRule[0], match = matchedRule[1];
- if (name === 'searchbot') {
- return new BotInfo();
- }
- // Do not use RegExp for split operation as some browser do not support it (See: http://blog.stevenlevithan.com/archives/cross-browser-split)
- var versionParts = match[1] && match[1].split('.').join('_').split('_').slice(0, 3);
- if (versionParts) {
- if (versionParts.length < REQUIRED_VERSION_PARTS) {
- versionParts = __spreadArray(__spreadArray([], versionParts, true), createVersionParts(REQUIRED_VERSION_PARTS - versionParts.length), true);
- }
- }
- else {
- versionParts = [];
- }
- var version = versionParts.join('.');
- var os = detectOS(ua);
- var searchBotMatch = SEARCHBOT_OS_REGEX.exec(ua);
- if (searchBotMatch && searchBotMatch[1]) {
- return new SearchBotDeviceInfo(name, version, os, searchBotMatch[1]);
- }
- return new BrowserInfo(name, version, os);
-}
-function detectOS(ua) {
- for (var ii = 0, count = operatingSystemRules.length; ii < count; ii++) {
- var _a = operatingSystemRules[ii], os = _a[0], regex = _a[1];
- var match = regex.exec(ua);
- if (match) {
- return os;
- }
- }
- return null;
-}
-function getNodeVersion() {
- var isNode = typeof process !== 'undefined' && process.version;
- return isNode ? new NodeInfo(process.version.slice(1)) : null;
-}
-function createVersionParts(count) {
- var output = [];
- for (var ii = 0; ii < count; ii++) {
- output.push('0');
- }
- return output;
-}
-
-/*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-var browserInfo = detect();
-var logs$1;
-var config$1;
-
-// Interval Logging Globals
-var intervalID;
-var intervalType;
-var intervalPath;
-var intervalTimer;
-var intervalCounter;
-var intervalLog;
-var cbHandlers = {};
-
-/**
- * Adds named callbacks to be executed when logging.
- * @param {Object } newCallbacks An object containing named callback functions.
- */
-function addCallbacks() {
- for (var _len = arguments.length, newCallbacks = new Array(_len), _key = 0; _key < _len; _key++) {
- newCallbacks[_key] = arguments[_key];
- }
- newCallbacks.forEach(function (source) {
- var descriptors = Object.keys(source).reduce(function (descriptors, key) {
- descriptors[key] = Object.getOwnPropertyDescriptor(source, key);
- return descriptors;
- }, {});
- Object.getOwnPropertySymbols(source).forEach(function (sym) {
- var descriptor = Object.getOwnPropertyDescriptor(source, sym);
- if (descriptor.enumerable) {
- descriptors[sym] = descriptor;
- }
- });
- Object.defineProperties(cbHandlers, descriptors);
- });
- return cbHandlers;
-}
-
-/**
- * Assigns the config and log container to be used by the logging functions.
- * @param {Array} newLogs Log container.
- * @param {Object} newConfig Configuration to use while logging.
- */
-function initPackager(newLogs, newConfig) {
- logs$1 = newLogs;
- config$1 = newConfig;
- cbHandlers = [];
- intervalID = null;
- intervalType = null;
- intervalPath = null;
- intervalTimer = null;
- intervalCounter = 0;
- intervalLog = null;
-}
-
-/**
- * Transforms the provided HTML event into a log and appends it to the log queue.
- * @param {Object} e The event to be logged.
- * @param {Function} detailFcn The function to extract additional log parameters from the event.
- * @return {boolean} Whether the event was logged.
- */
-function packageLog(e, detailFcn) {
- if (!config$1.on) {
- return false;
- }
- var details = null;
- if (detailFcn) {
- details = detailFcn(e);
- }
- var timeFields = extractTimeFields(e.timeStamp && e.timeStamp > 0 ? config$1.time(e.timeStamp) : Date.now());
- var log = {
- 'target': getSelector(e.target),
- 'path': buildPath(e),
- 'pageUrl': window.location.href,
- 'pageTitle': document.title,
- 'pageReferrer': document.referrer,
- 'browser': detectBrowser(),
- 'clientTime': timeFields.milli,
- 'microTime': timeFields.micro,
- 'location': getLocation(e),
- 'scrnRes': getSreenRes(),
- 'type': e.type,
- 'logType': 'raw',
- 'userAction': true,
- 'details': details,
- 'userId': config$1.userId,
- 'toolVersion': config$1.version,
- 'toolName': config$1.toolName,
- 'useraleVersion': config$1.useraleVersion,
- 'sessionID': config$1.sessionID
- };
- for (var _i = 0, _Object$values = Object.values(cbHandlers); _i < _Object$values.length; _i++) {
- var func = _Object$values[_i];
- if (typeof func === 'function') {
- log = func(log, e);
- if (!log) {
- return false;
- }
- }
- }
- logs$1.push(log);
- return true;
-}
-
-/**
- * Packages the provided customLog to include standard meta data and appends it to the log queue.
- * @param {Object} customLog The behavior to be logged.
- * @param {Function} detailFcn The function to extract additional log parameters from the event.
- * @param {boolean} userAction Indicates user behavior (true) or system behavior (false)
- * @return {boolean} Whether the event was logged.
- */
-function packageCustomLog(customLog, detailFcn, userAction) {
- if (!config$1.on) {
- return false;
- }
- var details = null;
- if (detailFcn) {
- details = detailFcn();
- }
- var metaData = {
- 'pageUrl': window.location.href,
- 'pageTitle': document.title,
- 'pageReferrer': document.referrer,
- 'browser': detectBrowser(),
- 'clientTime': Date.now(),
- 'scrnRes': getSreenRes(),
- 'logType': 'custom',
- 'userAction': userAction,
- 'details': details,
- 'userId': config$1.userId,
- 'toolVersion': config$1.version,
- 'toolName': config$1.toolName,
- 'useraleVersion': config$1.useraleVersion,
- 'sessionID': config$1.sessionID
- };
- var log = Object.assign(metaData, customLog);
- for (var _i2 = 0, _Object$values2 = Object.values(cbHandlers); _i2 < _Object$values2.length; _i2++) {
- var func = _Object$values2[_i2];
- if (typeof func === 'function') {
- log = func(log, null);
- if (!log) {
- return false;
- }
- }
- }
- logs$1.push(log);
- return true;
-}
-
-/**
- * Extract the millisecond and microsecond portions of a timestamp.
- * @param {Number} timeStamp The timestamp to split into millisecond and microsecond fields.
- * @return {Object} An object containing the millisecond
- * and microsecond portions of the timestamp.
- */
-function extractTimeFields(timeStamp) {
- return {
- milli: Math.floor(timeStamp),
- micro: Number((timeStamp % 1).toFixed(3))
- };
-}
-
-/**
- * Track intervals and gather details about it.
- * @param {Object} e
- * @return boolean
- */
-function packageIntervalLog(e) {
- var target = getSelector(e.target);
- var path = buildPath(e);
- var type = e.type;
- var timestamp = Math.floor(e.timeStamp && e.timeStamp > 0 ? config$1.time(e.timeStamp) : Date.now());
-
- // Init - this should only happen once on initialization
- if (intervalID == null) {
- intervalID = target;
- intervalType = type;
- intervalPath = path;
- intervalTimer = timestamp;
- intervalCounter = 0;
- }
- if (intervalID !== target || intervalType !== type) {
- // When to create log? On transition end
- // @todo Possible for intervalLog to not be pushed in the event the interval never ends...
-
- intervalLog = {
- 'target': intervalID,
- 'path': intervalPath,
- 'pageUrl': window.location.href,
- 'pageTitle': document.title,
- 'pageReferrer': document.referrer,
- 'browser': detectBrowser(),
- 'count': intervalCounter,
- 'duration': timestamp - intervalTimer,
- // microseconds
- 'startTime': intervalTimer,
- 'endTime': timestamp,
- 'type': intervalType,
- 'logType': 'interval',
- 'targetChange': intervalID !== target,
- 'typeChange': intervalType !== type,
- 'userAction': false,
- 'userId': config$1.userId,
- 'toolVersion': config$1.version,
- 'toolName': config$1.toolName,
- 'useraleVersion': config$1.useraleVersion,
- 'sessionID': config$1.sessionID
- };
- for (var _i3 = 0, _Object$values3 = Object.values(cbHandlers); _i3 < _Object$values3.length; _i3++) {
- var func = _Object$values3[_i3];
- if (typeof func === 'function') {
- intervalLog = func(intervalLog, null);
- if (!intervalLog) {
- return false;
- }
- }
- }
- logs$1.push(intervalLog);
-
- // Reset
- intervalID = target;
- intervalType = type;
- intervalPath = path;
- intervalTimer = timestamp;
- intervalCounter = 0;
- }
-
- // Interval is still occuring, just update counter
- if (intervalID == target && intervalType == type) {
- intervalCounter = intervalCounter + 1;
- }
- return true;
-}
-
-/**
- * Extracts coordinate information from the event
- * depending on a few browser quirks.
- * @param {Object} e The event to extract coordinate information from.
- * @return {Object} An object containing nullable x and y coordinates for the event.
- */
-function getLocation(e) {
- if (e.pageX != null) {
- return {
- 'x': e.pageX,
- 'y': e.pageY
- };
- } else if (e.clientX != null) {
- return {
- 'x': document.documentElement.scrollLeft + e.clientX,
- 'y': document.documentElement.scrollTop + e.clientY
- };
- } else {
- return {
- 'x': null,
- 'y': null
- };
- }
-}
-
-/**
- * Extracts innerWidth and innerHeight to provide estimates of screen resolution
- * @return {Object} An object containing the innerWidth and InnerHeight
- */
-function getSreenRes() {
- return {
- 'width': window.innerWidth,
- 'height': window.innerHeight
- };
-}
-
-/**
- * Builds a string CSS selector from the provided element
- * @param {HTMLElement} ele The element from which the selector is built.
- * @return {string} The CSS selector for the element, or Unknown if it can't be determined.
- */
-function getSelector(ele) {
- if (ele.localName) {
- return ele.localName + (ele.id ? '#' + ele.id : '') + (ele.className ? '.' + ele.className : '');
- } else if (ele.nodeName) {
- return ele.nodeName + (ele.id ? '#' + ele.id : '') + (ele.className ? '.' + ele.className : '');
- } else if (ele && ele.document && ele.location && ele.alert && ele.setInterval) {
- return "Window";
- } else {
- return "Unknown";
- }
-}
-
-/**
- * Builds an array of elements from the provided event target, to the root element.
- * @param {Object} e Event from which the path should be built.
- * @return {HTMLElement[]} Array of elements, starting at the event target, ending at the root element.
- */
-function buildPath(e) {
- if (e instanceof window.Event) {
- var path = e.composedPath();
- return selectorizePath(path);
- }
-}
-
-/**
- * Builds a CSS selector path from the provided list of elements.
- * @param {HTMLElement[]} path Array of HTMLElements from which the path should be built.
- * @return {string[]} Array of string CSS selectors.
- */
-function selectorizePath(path) {
- var i = 0;
- var pathEle;
- var pathSelectors = [];
- while (pathEle = path[i]) {
- pathSelectors.push(getSelector(pathEle));
- ++i;
- }
- return pathSelectors;
-}
-function detectBrowser() {
- return {
- 'browser': browserInfo ? browserInfo.name : '',
- 'version': browserInfo ? browserInfo.version : ''
- };
-}
-
-/*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-var events;
-var bufferBools;
-var bufferedEvents;
-//@todo: Investigate drag events and their behavior
-var intervalEvents = ['click', 'focus', 'blur', 'input', 'change', 'mouseover', 'submit'];
-var refreshEvents;
-var windowEvents = ['load', 'blur', 'focus'];
-
-/**
- * Maps an event to an object containing useful information.
- * @param {Object} e Event to extract data from
- */
-function extractMouseEvent(e) {
- return {
- 'clicks': e.detail,
- 'ctrl': e.ctrlKey,
- 'alt': e.altKey,
- 'shift': e.shiftKey,
- 'meta': e.metaKey
- // 'text' : e.target.innerHTML
- };
-}
-
-/**
- * Defines the way information is extracted from various events.
- * Also defines which events we will listen to.
- * @param {Object} config Configuration object to read from.
- */
-function defineDetails(config) {
- // Events list
- // Keys are event types
- // Values are functions that return details object if applicable
- events = {
- 'click': extractMouseEvent,
- 'dblclick': extractMouseEvent,
- 'mousedown': extractMouseEvent,
- 'mouseup': extractMouseEvent,
- 'focus': null,
- 'blur': null,
- 'input': config.logDetails ? function (e) {
- return {
- 'value': e.target.value
- };
- } : null,
- 'change': config.logDetails ? function (e) {
- return {
- 'value': e.target.value
- };
- } : null,
- 'dragstart': null,
- 'dragend': null,
- 'drag': null,
- 'drop': null,
- 'keydown': config.logDetails ? function (e) {
- return {
- 'key': e.keyCode,
- 'ctrl': e.ctrlKey,
- 'alt': e.altKey,
- 'shift': e.shiftKey,
- 'meta': e.metaKey
- };
- } : null,
- 'mouseover': null
- };
- bufferBools = {};
- bufferedEvents = {
- 'wheel': function wheel(e) {
- return {
- 'x': e.deltaX,
- 'y': e.deltaY,
- 'z': e.deltaZ
- };
- },
- 'scroll': function scroll() {
- return {
- 'x': window.scrollX,
- 'y': window.scrollY
- };
- },
- 'resize': function resize() {
- return {
- 'width': window.outerWidth,
- 'height': window.outerHeight
- };
- }
- };
- refreshEvents = {
- 'submit': null
- };
-}
-
-/**
- * Hooks the event handlers for each event type of interest.
- * @param {Object} config Configuration object to use.
- * @return {boolean} Whether the operation succeeded
- */
-function attachHandlers(config) {
- defineDetails(config);
- Object.keys(events).forEach(function (ev) {
- document.addEventListener(ev, function (e) {
- packageLog(e, events[ev]);
- }, true);
- });
- intervalEvents.forEach(function (ev) {
- document.addEventListener(ev, function (e) {
- packageIntervalLog(e);
- }, true);
- });
- Object.keys(bufferedEvents).forEach(function (ev) {
- bufferBools[ev] = true;
- window.addEventListener(ev, function (e) {
- if (bufferBools[ev]) {
- bufferBools[ev] = false;
- packageLog(e, bufferedEvents[ev]);
- setTimeout(function () {
- bufferBools[ev] = true;
- }, config.resolution);
- }
- }, true);
- });
- Object.keys(refreshEvents).forEach(function (ev) {
- document.addEventListener(ev, function (e) {
- packageLog(e, events[ev]);
- }, true);
- });
- windowEvents.forEach(function (ev) {
- window.addEventListener(ev, function (e) {
- packageLog(e, function () {
- return {
- 'window': true
- };
- });
- }, true);
- });
- return true;
-}
-
-function _arrayWithHoles(arr) {
- if (Array.isArray(arr)) return arr;
-}
-
-function _iterableToArrayLimit(r, l) {
- var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"];
- if (null != t) {
- var e,
- n,
- i,
- u,
- a = [],
- f = !0,
- o = !1;
- try {
- if (i = (t = t.call(r)).next, 0 === l) {
- if (Object(t) !== t) return;
- f = !1;
- } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0);
- } catch (r) {
- o = !0, n = r;
- } finally {
- try {
- if (!f && null != t["return"] && (u = t["return"](), Object(u) !== u)) return;
- } finally {
- if (o) throw n;
- }
- }
- return a;
- }
-}
-
-function _arrayLikeToArray(arr, len) {
- if (len == null || len > arr.length) len = arr.length;
- for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i];
- return arr2;
-}
-
-function _unsupportedIterableToArray(o, minLen) {
- if (!o) return;
- if (typeof o === "string") return _arrayLikeToArray(o, minLen);
- var n = Object.prototype.toString.call(o).slice(8, -1);
- if (n === "Object" && o.constructor) n = o.constructor.name;
- if (n === "Map" || n === "Set") return Array.from(o);
- if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen);
-}
-
-function _nonIterableRest() {
- throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
-}
-
-function _slicedToArray(arr, i) {
- return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest();
-}
-
-var sendIntervalId = null;
-
-/**
- * Initializes the log queue processors.
- * @param {Array} logs Array of logs to append to.
- * @param {Object} config Configuration object to use when logging.
- */
-function initSender(logs, config) {
- if (sendIntervalId !== null) {
- clearInterval(sendIntervalId);
- }
- sendIntervalId = sendOnInterval(logs, config);
- sendOnClose(logs, config);
-}
-
-/**
- * Checks the provided log array on an interval, flushing the logs
- * if the queue has reached the threshold specified by the provided config.
- * @param {Array} logs Array of logs to read from.
- * @param {Object} config Configuration object to be read from.
- * @return {Number} The newly created interval id.
- */
-function sendOnInterval(logs, config) {
- return setInterval(function () {
- if (!config.on) {
- return;
- }
- if (logs.length >= config.logCountThreshold) {
- sendLogs(logs.slice(0), config, 0); // Send a copy
- logs.splice(0); // Clear array reference (no reassignment)
- }
- }, config.transmitInterval);
-}
-
-/**
- * Attempts to flush the remaining logs when the window is closed.
- * @param {Array} logs Array of logs to be flushed.
- * @param {Object} config Configuration object to be read from.
- */
-function sendOnClose(logs, config) {
- window.addEventListener("pagehide", function () {
- if (config.on && logs.length > 0) {
- // NOTE: sendBeacon does not support auth headers,
- // so this will fail if auth is required.
- // The alternative is to use fetch() with keepalive: true
- // https://developer.mozilla.org/en-US/docs/Web/API/Navigator/sendBeacon#description
- // https://stackoverflow.com/a/73062712/9263449
- navigator.sendBeacon(config.url, JSON.stringify(logs));
- logs.splice(0); // clear log queue
- }
- });
-}
-
-/**
- * Sends the provided array of logs to the specified url,
- * retrying the request up to the specified number of retries.
- * @param {Array} logs Array of logs to send.
- * @param {string} config configuration parameters (e.g., to extract URL from & send the POST request to).
- * @param {Number} retries Maximum number of attempts to send the logs.
- */
-
-// @todo expose config object to sendLogs replate url with config.url
-function sendLogs(logs, config, retries) {
- var req = new XMLHttpRequest();
- var data = JSON.stringify(logs);
- req.open("POST", config.url);
- if (config.authHeader) {
- req.setRequestHeader("Authorization", config.authHeader);
- }
- req.setRequestHeader("Content-type", "application/json;charset=UTF-8");
- if (config.headers) {
- Object.entries(config.headers).forEach(function (_ref) {
- var _ref2 = _slicedToArray(_ref, 2),
- header = _ref2[0],
- value = _ref2[1];
- req.setRequestHeader(header, value);
- });
- }
- req.onreadystatechange = function () {
- if (req.readyState === 4 && req.status !== 200) {
- if (retries > 0) {
- sendLogs(logs, config, retries--);
- }
- }
- };
- req.send(data);
-}
-
-var config = {};
-var logs = [];
-var startLoadTimestamp = Date.now();
-var endLoadTimestamp;
-window.onload = function () {
- endLoadTimestamp = Date.now();
-};
-var started = false;
-
-// Start up Userale
-config.on = false;
-config.useraleVersion = version$1;
-configure(config, getInitialSettings());
-initPackager(logs, config);
-if (config.autostart) {
- setup(config);
-}
-
-/**
- * Hooks the global event listener, and starts up the
- * logging interval.
- * @param {Object} config Configuration settings for the logger
- */
-function setup(config) {
- if (!started) {
- setTimeout(function () {
- var state = document.readyState;
- if (config.autostart && (state === 'interactive' || state === 'complete')) {
- attachHandlers(config);
- initSender(logs, config);
- started = config.on = true;
- packageCustomLog({
- type: 'load',
- details: {
- pageLoadTime: endLoadTimestamp - startLoadTimestamp
- }
- }, function () {}, false);
- } else {
- setup(config);
- }
- }, 100);
- }
-}
-
-// Export the Userale API
-var version = version$1;
-
-/**
- * Updates the current configuration
- * object with the provided values.
- * @param {Object} newConfig The configuration options to use.
- * @return {Object} Returns the updated configuration.
- */
-function options(newConfig) {
- if (newConfig !== undefined) {
- configure(config, newConfig);
- }
- return config;
-}
-
-/**
- * Appends a log to the log queue.
- * @param {Object} customLog The log to append.
- * @return {boolean} Whether the operation succeeded.
- */
-function log(customLog) {
- if (customLog !== null && _typeof(customLog) === 'object') {
- logs.push(customLog);
- return true;
- } else {
- return false;
- }
-}
-
-/*
-* Licensed to the Apache Software Foundation (ASF) under one or more
-* contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
-* The ASF licenses this file to You under the Apache License, Version 2.0
-* (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
-
-
-// browser is defined in firefox, but chrome uses the 'chrome' global.
-var browser = browser || chrome;
-
-/* eslint-enable */
-
-/*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-
-// Initalize userale plugin options
-var defaultConfig = {
- useraleConfig: {
- url: 'http://localhost:8000',
- userId: 'pluginUser',
- authHeader: null,
- toolName: 'useralePlugin',
- version: version
- },
- pluginConfig: {
- // Default to a regex that will match no string
- urlWhitelist: '(?!x)x'
- }
-};
-var urlWhitelist;
-function updateConfig(config) {
- console.log(config);
- urlWhitelist = new RegExp(config.pluginConfig.urlWhitelist);
- options(config.useraleConfig);
- // TODO: tabs need a page load to apply this config change.
- dispatchTabMessage(config.useraleConfig);
-}
-function dispatchTabMessage(message) {
- browser.tabs.query({}, function (tabs) {
- tabs.forEach(function (tab) {
- browser.tabs.sendMessage(tab.id, message);
- });
- });
-}
-
-// Filter out logs with urls that do not match the regex defined in extension options.
-function filterUrl(log) {
- if (urlWhitelist.test(log.pageUrl)) {
- return log;
- }
- return false;
-}
-browser.storage.local.get(defaultConfig, function (res) {
- // Apply url filter to logs generated by the background page.
- addCallbacks({
- filterUrl: filterUrl
- });
- updateConfig(res);
-});
-browser.runtime.onMessage.addListener(function (message, sender, sendResponse) {
- switch (message.type) {
- // Handles logs rerouted from content and option scripts.
- case ADD_LOG:
- var log$1 = message.payload;
- if ("tab" in sender && "id" in sender.tab) {
- log$1["tabId"] = sender.tab.id;
- }
- // Apply url filter to logs generated outside the background page.
- log$1 = filterUrl(log$1);
- if (log$1) {
- console.log("match");
- log(log$1);
- }
- break;
- case CONFIG_CHANGE:
- updateConfig(message.payload);
- break;
- default:
- console.log('got unknown message type ', message);
- }
-});
-
-// Helper functions for logging tab events
-function packageTabLog(tabId, data, type) {
- browser.tabs.get(tabId, function (tab) {
- packageDetailedTabLog(tab, data, type);
- });
-}
-function packageDetailedTabLog(tab, data, type) {
- Object.assign(data, {
- 'tabEvent': type
- });
- packageCustomLog(data, function () {
- return tab;
- }, true);
-}
-
-// Attach Handlers for tab events
-// https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/tabs
-browser.tabs.onActivated.addListener(function (activeInfo) {
- packageTabLog(activeInfo.tabId, activeInfo, "tabs.onActivated");
-});
-browser.tabs.onAttached.addListener(function (tabId, attachInfo) {
- packageTabLog(tabId, attachInfo, "tabs.onAttached");
-});
-browser.tabs.onCreated.addListener(function (tab) {
- packageDetailedTabLog(tab, {}, "tabs.onCreated");
-});
-browser.tabs.onDetached.addListener(function (tabId, detachInfo) {
- packageTabLog(tabId, detachInfo, "tabs.onDetached");
-});
-browser.tabs.onMoved.addListener(function (tabId, moveInfo) {
- packageTabLog(tabId, moveInfo, "tabs.onMoved");
-});
-browser.tabs.onRemoved.addListener(function (tabId, removeInfo) {
- packageDetailedTabLog({
- id: tabId
- }, removeInfo, "tabs.onRemoved");
-});
-browser.tabs.onUpdated.addListener(function (tabId, changeInfo, tab) {
- packageDetailedTabLog(tab, changeInfo, "tabs.onUpdated");
-});
-browser.tabs.onZoomChange.addListener(function (ZoomChangeInfo) {
- packageTabLog(ZoomChangeInfo.tabId, ZoomChangeInfo, "tabs.onZoomChange");
-});
-
-/*
- eslint-enable
- */
diff --git a/build/UserALEWebExtension/content.js b/build/UserALEWebExtension/content.js
deleted file mode 100644
index 8dcf1de..0000000
--- a/build/UserALEWebExtension/content.js
+++ /dev/null
@@ -1,1144 +0,0 @@
-/*
-* Licensed to the Apache Software Foundation (ASF) under one or more
-* contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
-* The ASF licenses this file to You under the Apache License, Version 2.0
-* (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
-
-var prefix = 'USERALE_';
-var CONFIG_CHANGE = prefix + 'CONFIG_CHANGE';
-var ADD_LOG = prefix + 'ADD_LOG';
-
-var version = "2.4.0";
-
-/*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the 'License'); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an 'AS IS' BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-var sessionId = null;
-
-/**
- * Extracts the initial configuration settings from the
- * currently executing script tag.
- * @return {Object} The extracted configuration object
- */
-function getInitialSettings() {
- var settings = {};
- if (sessionId === null) {
- sessionId = getSessionId('userAleSessionId', 'session_' + String(Date.now()));
- }
- var script = document.currentScript || function () {
- var scripts = document.getElementsByTagName('script');
- return scripts[scripts.length - 1];
- }();
- var get = script ? script.getAttribute.bind(script) : function () {
- return null;
- };
- settings.autostart = get('data-autostart') === 'false' ? false : true;
- settings.url = get('data-url') || 'http://localhost:8000';
- settings.transmitInterval = +get('data-interval') || 5000;
- settings.logCountThreshold = +get('data-threshold') || 5;
- settings.userId = get('data-user') || null;
- settings.version = get('data-version') || null;
- settings.logDetails = get('data-log-details') === 'true' ? true : false;
- settings.resolution = +get('data-resolution') || 500;
- settings.toolName = get('data-tool') || null;
- settings.userFromParams = get('data-user-from-params') || null;
- settings.time = timeStampScale(document.createEvent('CustomEvent'));
- settings.sessionID = get('data-session') || sessionId;
- settings.authHeader = get('data-auth') || null;
- settings.custIndex = get('data-index') || null;
- settings.headers = get('data-headers') || null;
- return settings;
-}
-
-/**
- * defines sessionId, stores it in sessionStorage, checks to see if there is a sessionId in
- * storage when script is started. This prevents events like 'submit', which refresh page data
- * from refreshing the current user session
- *
- */
-function getSessionId(sessionKey, value) {
- if (window.sessionStorage.getItem(sessionKey) === null) {
- window.sessionStorage.setItem(sessionKey, JSON.stringify(value));
- return value;
- }
- return JSON.parse(window.sessionStorage.getItem(sessionKey));
-}
-
-/**
- * Creates a function to normalize the timestamp of the provided event.
- * @param {Object} e An event containing a timeStamp property.
- * @return {timeStampScale~tsScaler} The timestamp normalizing function.
- */
-function timeStampScale(e) {
- var tsScaler;
- if (e.timeStamp && e.timeStamp > 0) {
- var delta = Date.now() - e.timeStamp;
- /**
- * Returns a timestamp depending on various browser quirks.
- * @param {?Number} ts A timestamp to use for normalization.
- * @return {Number} A normalized timestamp.
- */
-
- if (delta < 0) {
- tsScaler = function tsScaler() {
- return e.timeStamp / 1000;
- };
- } else if (delta > e.timeStamp) {
- var navStart = performance.timing.navigationStart;
- tsScaler = function tsScaler(ts) {
- return ts + navStart;
- };
- } else {
- tsScaler = function tsScaler(ts) {
- return ts;
- };
- }
- } else {
- tsScaler = function tsScaler() {
- return Date.now();
- };
- }
- return tsScaler;
-}
-
-/*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-/**
- * Shallow merges the first argument with the second.
- * Retrieves/updates the userid if userFromParams is provided.
- * @param {Object} config Current configuration object to be merged into.
- * @param {Object} newConfig Configuration object to merge into the current config.
- */
-function configure(config, newConfig) {
- var configAutostart = config['autostart'];
- var newConfigAutostart = newConfig['autostart'];
- Object.keys(newConfig).forEach(function (option) {
- if (option === 'userFromParams') {
- var userId = getUserIdFromParams(newConfig[option]);
- if (userId) {
- config.userId = userId;
- }
- }
- config[option] = newConfig[option];
- });
- if (configAutostart === false || newConfigAutostart === false) {
- config['autostart'] = false;
- }
-}
-
-/**
- * Attempts to extract the userid from the query parameters of the URL.
- * @param {string} param The name of the query parameter containing the userid.
- * @return {string|null} The extracted/decoded userid, or null if none is found.
- */
-function getUserIdFromParams(param) {
- var userField = param;
- var regex = new RegExp('[?&]' + userField + '(=([^&#]*)|&|#|$)');
- var results = window.location.href.match(regex);
- if (results && results[2]) {
- return decodeURIComponent(results[2].replace(/\+/g, ' '));
- } else {
- return null;
- }
-}
-
-var __spreadArray = (undefined && undefined.__spreadArray) || function (to, from, pack) {
- if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
- if (ar || !(i in from)) {
- if (!ar) ar = Array.prototype.slice.call(from, 0, i);
- ar[i] = from[i];
- }
- }
- return to.concat(ar || Array.prototype.slice.call(from));
-};
-var BrowserInfo = /** @class */ (function () {
- function BrowserInfo(name, version, os) {
- this.name = name;
- this.version = version;
- this.os = os;
- this.type = 'browser';
- }
- return BrowserInfo;
-}());
-var NodeInfo = /** @class */ (function () {
- function NodeInfo(version) {
- this.version = version;
- this.type = 'node';
- this.name = 'node';
- this.os = process.platform;
- }
- return NodeInfo;
-}());
-var SearchBotDeviceInfo = /** @class */ (function () {
- function SearchBotDeviceInfo(name, version, os, bot) {
- this.name = name;
- this.version = version;
- this.os = os;
- this.bot = bot;
- this.type = 'bot-device';
- }
- return SearchBotDeviceInfo;
-}());
-var BotInfo = /** @class */ (function () {
- function BotInfo() {
- this.type = 'bot';
- this.bot = true; // NOTE: deprecated test name instead
- this.name = 'bot';
- this.version = null;
- this.os = null;
- }
- return BotInfo;
-}());
-var ReactNativeInfo = /** @class */ (function () {
- function ReactNativeInfo() {
- this.type = 'react-native';
- this.name = 'react-native';
- this.version = null;
- this.os = null;
- }
- return ReactNativeInfo;
-}());
-// tslint:disable-next-line:max-line-length
-var SEARCHBOX_UA_REGEX = /alexa|bot|crawl(er|ing)|facebookexternalhit|feedburner|google web preview|nagios|postrank|pingdom|slurp|spider|yahoo!|yandex/;
-var SEARCHBOT_OS_REGEX = /(nuhk|curl|Googlebot|Yammybot|Openbot|Slurp|MSNBot|Ask\ Jeeves\/Teoma|ia_archiver)/;
-var REQUIRED_VERSION_PARTS = 3;
-var userAgentRules = [
- ['aol', /AOLShield\/([0-9\._]+)/],
- ['edge', /Edge\/([0-9\._]+)/],
- ['edge-ios', /EdgiOS\/([0-9\._]+)/],
- ['yandexbrowser', /YaBrowser\/([0-9\._]+)/],
- ['kakaotalk', /KAKAOTALK\s([0-9\.]+)/],
- ['samsung', /SamsungBrowser\/([0-9\.]+)/],
- ['silk', /\bSilk\/([0-9._-]+)\b/],
- ['miui', /MiuiBrowser\/([0-9\.]+)$/],
- ['beaker', /BeakerBrowser\/([0-9\.]+)/],
- ['edge-chromium', /EdgA?\/([0-9\.]+)/],
- [
- 'chromium-webview',
- /(?!Chrom.*OPR)wv\).*Chrom(?:e|ium)\/([0-9\.]+)(:?\s|$)/,
- ],
- ['chrome', /(?!Chrom.*OPR)Chrom(?:e|ium)\/([0-9\.]+)(:?\s|$)/],
- ['phantomjs', /PhantomJS\/([0-9\.]+)(:?\s|$)/],
- ['crios', /CriOS\/([0-9\.]+)(:?\s|$)/],
- ['firefox', /Firefox\/([0-9\.]+)(?:\s|$)/],
- ['fxios', /FxiOS\/([0-9\.]+)/],
- ['opera-mini', /Opera Mini.*Version\/([0-9\.]+)/],
- ['opera', /Opera\/([0-9\.]+)(?:\s|$)/],
- ['opera', /OPR\/([0-9\.]+)(:?\s|$)/],
- ['pie', /^Microsoft Pocket Internet Explorer\/(\d+\.\d+)$/],
- ['pie', /^Mozilla\/\d\.\d+\s\(compatible;\s(?:MSP?IE|MSInternet Explorer) (\d+\.\d+);.*Windows CE.*\)$/],
- ['netfront', /^Mozilla\/\d\.\d+.*NetFront\/(\d.\d)/],
- ['ie', /Trident\/7\.0.*rv\:([0-9\.]+).*\).*Gecko$/],
- ['ie', /MSIE\s([0-9\.]+);.*Trident\/[4-7].0/],
- ['ie', /MSIE\s(7\.0)/],
- ['bb10', /BB10;\sTouch.*Version\/([0-9\.]+)/],
- ['android', /Android\s([0-9\.]+)/],
- ['ios', /Version\/([0-9\._]+).*Mobile.*Safari.*/],
- ['safari', /Version\/([0-9\._]+).*Safari/],
- ['facebook', /FB[AS]V\/([0-9\.]+)/],
- ['instagram', /Instagram\s([0-9\.]+)/],
- ['ios-webview', /AppleWebKit\/([0-9\.]+).*Mobile/],
- ['ios-webview', /AppleWebKit\/([0-9\.]+).*Gecko\)$/],
- ['curl', /^curl\/([0-9\.]+)$/],
- ['searchbot', SEARCHBOX_UA_REGEX],
-];
-var operatingSystemRules = [
- ['iOS', /iP(hone|od|ad)/],
- ['Android OS', /Android/],
- ['BlackBerry OS', /BlackBerry|BB10/],
- ['Windows Mobile', /IEMobile/],
- ['Amazon OS', /Kindle/],
- ['Windows 3.11', /Win16/],
- ['Windows 95', /(Windows 95)|(Win95)|(Windows_95)/],
- ['Windows 98', /(Windows 98)|(Win98)/],
- ['Windows 2000', /(Windows NT 5.0)|(Windows 2000)/],
- ['Windows XP', /(Windows NT 5.1)|(Windows XP)/],
- ['Windows Server 2003', /(Windows NT 5.2)/],
- ['Windows Vista', /(Windows NT 6.0)/],
- ['Windows 7', /(Windows NT 6.1)/],
- ['Windows 8', /(Windows NT 6.2)/],
- ['Windows 8.1', /(Windows NT 6.3)/],
- ['Windows 10', /(Windows NT 10.0)/],
- ['Windows ME', /Windows ME/],
- ['Windows CE', /Windows CE|WinCE|Microsoft Pocket Internet Explorer/],
- ['Open BSD', /OpenBSD/],
- ['Sun OS', /SunOS/],
- ['Chrome OS', /CrOS/],
- ['Linux', /(Linux)|(X11)/],
- ['Mac OS', /(Mac_PowerPC)|(Macintosh)/],
- ['QNX', /QNX/],
- ['BeOS', /BeOS/],
- ['OS/2', /OS\/2/],
-];
-function detect(userAgent) {
- if (!!userAgent) {
- return parseUserAgent(userAgent);
- }
- if (typeof document === 'undefined' &&
- typeof navigator !== 'undefined' &&
- navigator.product === 'ReactNative') {
- return new ReactNativeInfo();
- }
- if (typeof navigator !== 'undefined') {
- return parseUserAgent(navigator.userAgent);
- }
- return getNodeVersion();
-}
-function matchUserAgent(ua) {
- // opted for using reduce here rather than Array#first with a regex.test call
- // this is primarily because using the reduce we only perform the regex
- // execution once rather than once for the test and for the exec again below
- // probably something that needs to be benchmarked though
- return (ua !== '' &&
- userAgentRules.reduce(function (matched, _a) {
- var browser = _a[0], regex = _a[1];
- if (matched) {
- return matched;
- }
- var uaMatch = regex.exec(ua);
- return !!uaMatch && [browser, uaMatch];
- }, false));
-}
-function parseUserAgent(ua) {
- var matchedRule = matchUserAgent(ua);
- if (!matchedRule) {
- return null;
- }
- var name = matchedRule[0], match = matchedRule[1];
- if (name === 'searchbot') {
- return new BotInfo();
- }
- // Do not use RegExp for split operation as some browser do not support it (See: http://blog.stevenlevithan.com/archives/cross-browser-split)
- var versionParts = match[1] && match[1].split('.').join('_').split('_').slice(0, 3);
- if (versionParts) {
- if (versionParts.length < REQUIRED_VERSION_PARTS) {
- versionParts = __spreadArray(__spreadArray([], versionParts, true), createVersionParts(REQUIRED_VERSION_PARTS - versionParts.length), true);
- }
- }
- else {
- versionParts = [];
- }
- var version = versionParts.join('.');
- var os = detectOS(ua);
- var searchBotMatch = SEARCHBOT_OS_REGEX.exec(ua);
- if (searchBotMatch && searchBotMatch[1]) {
- return new SearchBotDeviceInfo(name, version, os, searchBotMatch[1]);
- }
- return new BrowserInfo(name, version, os);
-}
-function detectOS(ua) {
- for (var ii = 0, count = operatingSystemRules.length; ii < count; ii++) {
- var _a = operatingSystemRules[ii], os = _a[0], regex = _a[1];
- var match = regex.exec(ua);
- if (match) {
- return os;
- }
- }
- return null;
-}
-function getNodeVersion() {
- var isNode = typeof process !== 'undefined' && process.version;
- return isNode ? new NodeInfo(process.version.slice(1)) : null;
-}
-function createVersionParts(count) {
- var output = [];
- for (var ii = 0; ii < count; ii++) {
- output.push('0');
- }
- return output;
-}
-
-/*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-var browserInfo = detect();
-var logs$1;
-var config$1;
-
-// Interval Logging Globals
-var intervalID;
-var intervalType;
-var intervalPath;
-var intervalTimer;
-var intervalCounter;
-var intervalLog;
-var cbHandlers = {};
-
-/**
- * Adds named callbacks to be executed when logging.
- * @param {Object } newCallbacks An object containing named callback functions.
- */
-function addCallbacks() {
- for (var _len = arguments.length, newCallbacks = new Array(_len), _key = 0; _key < _len; _key++) {
- newCallbacks[_key] = arguments[_key];
- }
- newCallbacks.forEach(function (source) {
- var descriptors = Object.keys(source).reduce(function (descriptors, key) {
- descriptors[key] = Object.getOwnPropertyDescriptor(source, key);
- return descriptors;
- }, {});
- Object.getOwnPropertySymbols(source).forEach(function (sym) {
- var descriptor = Object.getOwnPropertyDescriptor(source, sym);
- if (descriptor.enumerable) {
- descriptors[sym] = descriptor;
- }
- });
- Object.defineProperties(cbHandlers, descriptors);
- });
- return cbHandlers;
-}
-
-/**
- * Assigns the config and log container to be used by the logging functions.
- * @param {Array} newLogs Log container.
- * @param {Object} newConfig Configuration to use while logging.
- */
-function initPackager(newLogs, newConfig) {
- logs$1 = newLogs;
- config$1 = newConfig;
- cbHandlers = [];
- intervalID = null;
- intervalType = null;
- intervalPath = null;
- intervalTimer = null;
- intervalCounter = 0;
- intervalLog = null;
-}
-
-/**
- * Transforms the provided HTML event into a log and appends it to the log queue.
- * @param {Object} e The event to be logged.
- * @param {Function} detailFcn The function to extract additional log parameters from the event.
- * @return {boolean} Whether the event was logged.
- */
-function packageLog(e, detailFcn) {
- if (!config$1.on) {
- return false;
- }
- var details = null;
- if (detailFcn) {
- details = detailFcn(e);
- }
- var timeFields = extractTimeFields(e.timeStamp && e.timeStamp > 0 ? config$1.time(e.timeStamp) : Date.now());
- var log = {
- 'target': getSelector(e.target),
- 'path': buildPath(e),
- 'pageUrl': window.location.href,
- 'pageTitle': document.title,
- 'pageReferrer': document.referrer,
- 'browser': detectBrowser(),
- 'clientTime': timeFields.milli,
- 'microTime': timeFields.micro,
- 'location': getLocation(e),
- 'scrnRes': getSreenRes(),
- 'type': e.type,
- 'logType': 'raw',
- 'userAction': true,
- 'details': details,
- 'userId': config$1.userId,
- 'toolVersion': config$1.version,
- 'toolName': config$1.toolName,
- 'useraleVersion': config$1.useraleVersion,
- 'sessionID': config$1.sessionID
- };
- for (var _i = 0, _Object$values = Object.values(cbHandlers); _i < _Object$values.length; _i++) {
- var func = _Object$values[_i];
- if (typeof func === 'function') {
- log = func(log, e);
- if (!log) {
- return false;
- }
- }
- }
- logs$1.push(log);
- return true;
-}
-
-/**
- * Packages the provided customLog to include standard meta data and appends it to the log queue.
- * @param {Object} customLog The behavior to be logged.
- * @param {Function} detailFcn The function to extract additional log parameters from the event.
- * @param {boolean} userAction Indicates user behavior (true) or system behavior (false)
- * @return {boolean} Whether the event was logged.
- */
-function packageCustomLog(customLog, detailFcn, userAction) {
- if (!config$1.on) {
- return false;
- }
- var details = null;
- if (detailFcn) {
- details = detailFcn();
- }
- var metaData = {
- 'pageUrl': window.location.href,
- 'pageTitle': document.title,
- 'pageReferrer': document.referrer,
- 'browser': detectBrowser(),
- 'clientTime': Date.now(),
- 'scrnRes': getSreenRes(),
- 'logType': 'custom',
- 'userAction': userAction,
- 'details': details,
- 'userId': config$1.userId,
- 'toolVersion': config$1.version,
- 'toolName': config$1.toolName,
- 'useraleVersion': config$1.useraleVersion,
- 'sessionID': config$1.sessionID
- };
- var log = Object.assign(metaData, customLog);
- for (var _i2 = 0, _Object$values2 = Object.values(cbHandlers); _i2 < _Object$values2.length; _i2++) {
- var func = _Object$values2[_i2];
- if (typeof func === 'function') {
- log = func(log, null);
- if (!log) {
- return false;
- }
- }
- }
- logs$1.push(log);
- return true;
-}
-
-/**
- * Extract the millisecond and microsecond portions of a timestamp.
- * @param {Number} timeStamp The timestamp to split into millisecond and microsecond fields.
- * @return {Object} An object containing the millisecond
- * and microsecond portions of the timestamp.
- */
-function extractTimeFields(timeStamp) {
- return {
- milli: Math.floor(timeStamp),
- micro: Number((timeStamp % 1).toFixed(3))
- };
-}
-
-/**
- * Track intervals and gather details about it.
- * @param {Object} e
- * @return boolean
- */
-function packageIntervalLog(e) {
- var target = getSelector(e.target);
- var path = buildPath(e);
- var type = e.type;
- var timestamp = Math.floor(e.timeStamp && e.timeStamp > 0 ? config$1.time(e.timeStamp) : Date.now());
-
- // Init - this should only happen once on initialization
- if (intervalID == null) {
- intervalID = target;
- intervalType = type;
- intervalPath = path;
- intervalTimer = timestamp;
- intervalCounter = 0;
- }
- if (intervalID !== target || intervalType !== type) {
- // When to create log? On transition end
- // @todo Possible for intervalLog to not be pushed in the event the interval never ends...
-
- intervalLog = {
- 'target': intervalID,
- 'path': intervalPath,
- 'pageUrl': window.location.href,
- 'pageTitle': document.title,
- 'pageReferrer': document.referrer,
- 'browser': detectBrowser(),
- 'count': intervalCounter,
- 'duration': timestamp - intervalTimer,
- // microseconds
- 'startTime': intervalTimer,
- 'endTime': timestamp,
- 'type': intervalType,
- 'logType': 'interval',
- 'targetChange': intervalID !== target,
- 'typeChange': intervalType !== type,
- 'userAction': false,
- 'userId': config$1.userId,
- 'toolVersion': config$1.version,
- 'toolName': config$1.toolName,
- 'useraleVersion': config$1.useraleVersion,
- 'sessionID': config$1.sessionID
- };
- for (var _i3 = 0, _Object$values3 = Object.values(cbHandlers); _i3 < _Object$values3.length; _i3++) {
- var func = _Object$values3[_i3];
- if (typeof func === 'function') {
- intervalLog = func(intervalLog, null);
- if (!intervalLog) {
- return false;
- }
- }
- }
- logs$1.push(intervalLog);
-
- // Reset
- intervalID = target;
- intervalType = type;
- intervalPath = path;
- intervalTimer = timestamp;
- intervalCounter = 0;
- }
-
- // Interval is still occuring, just update counter
- if (intervalID == target && intervalType == type) {
- intervalCounter = intervalCounter + 1;
- }
- return true;
-}
-
-/**
- * Extracts coordinate information from the event
- * depending on a few browser quirks.
- * @param {Object} e The event to extract coordinate information from.
- * @return {Object} An object containing nullable x and y coordinates for the event.
- */
-function getLocation(e) {
- if (e.pageX != null) {
- return {
- 'x': e.pageX,
- 'y': e.pageY
- };
- } else if (e.clientX != null) {
- return {
- 'x': document.documentElement.scrollLeft + e.clientX,
- 'y': document.documentElement.scrollTop + e.clientY
- };
- } else {
- return {
- 'x': null,
- 'y': null
- };
- }
-}
-
-/**
- * Extracts innerWidth and innerHeight to provide estimates of screen resolution
- * @return {Object} An object containing the innerWidth and InnerHeight
- */
-function getSreenRes() {
- return {
- 'width': window.innerWidth,
- 'height': window.innerHeight
- };
-}
-
-/**
- * Builds a string CSS selector from the provided element
- * @param {HTMLElement} ele The element from which the selector is built.
- * @return {string} The CSS selector for the element, or Unknown if it can't be determined.
- */
-function getSelector(ele) {
- if (ele.localName) {
- return ele.localName + (ele.id ? '#' + ele.id : '') + (ele.className ? '.' + ele.className : '');
- } else if (ele.nodeName) {
- return ele.nodeName + (ele.id ? '#' + ele.id : '') + (ele.className ? '.' + ele.className : '');
- } else if (ele && ele.document && ele.location && ele.alert && ele.setInterval) {
- return "Window";
- } else {
- return "Unknown";
- }
-}
-
-/**
- * Builds an array of elements from the provided event target, to the root element.
- * @param {Object} e Event from which the path should be built.
- * @return {HTMLElement[]} Array of elements, starting at the event target, ending at the root element.
- */
-function buildPath(e) {
- if (e instanceof window.Event) {
- var path = e.composedPath();
- return selectorizePath(path);
- }
-}
-
-/**
- * Builds a CSS selector path from the provided list of elements.
- * @param {HTMLElement[]} path Array of HTMLElements from which the path should be built.
- * @return {string[]} Array of string CSS selectors.
- */
-function selectorizePath(path) {
- var i = 0;
- var pathEle;
- var pathSelectors = [];
- while (pathEle = path[i]) {
- pathSelectors.push(getSelector(pathEle));
- ++i;
- }
- return pathSelectors;
-}
-function detectBrowser() {
- return {
- 'browser': browserInfo ? browserInfo.name : '',
- 'version': browserInfo ? browserInfo.version : ''
- };
-}
-
-/*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-var events;
-var bufferBools;
-var bufferedEvents;
-//@todo: Investigate drag events and their behavior
-var intervalEvents = ['click', 'focus', 'blur', 'input', 'change', 'mouseover', 'submit'];
-var refreshEvents;
-var windowEvents = ['load', 'blur', 'focus'];
-
-/**
- * Maps an event to an object containing useful information.
- * @param {Object} e Event to extract data from
- */
-function extractMouseEvent(e) {
- return {
- 'clicks': e.detail,
- 'ctrl': e.ctrlKey,
- 'alt': e.altKey,
- 'shift': e.shiftKey,
- 'meta': e.metaKey
- // 'text' : e.target.innerHTML
- };
-}
-
-/**
- * Defines the way information is extracted from various events.
- * Also defines which events we will listen to.
- * @param {Object} config Configuration object to read from.
- */
-function defineDetails(config) {
- // Events list
- // Keys are event types
- // Values are functions that return details object if applicable
- events = {
- 'click': extractMouseEvent,
- 'dblclick': extractMouseEvent,
- 'mousedown': extractMouseEvent,
- 'mouseup': extractMouseEvent,
- 'focus': null,
- 'blur': null,
- 'input': config.logDetails ? function (e) {
- return {
- 'value': e.target.value
- };
- } : null,
- 'change': config.logDetails ? function (e) {
- return {
- 'value': e.target.value
- };
- } : null,
- 'dragstart': null,
- 'dragend': null,
- 'drag': null,
- 'drop': null,
- 'keydown': config.logDetails ? function (e) {
- return {
- 'key': e.keyCode,
- 'ctrl': e.ctrlKey,
- 'alt': e.altKey,
- 'shift': e.shiftKey,
- 'meta': e.metaKey
- };
- } : null,
- 'mouseover': null
- };
- bufferBools = {};
- bufferedEvents = {
- 'wheel': function wheel(e) {
- return {
- 'x': e.deltaX,
- 'y': e.deltaY,
- 'z': e.deltaZ
- };
- },
- 'scroll': function scroll() {
- return {
- 'x': window.scrollX,
- 'y': window.scrollY
- };
- },
- 'resize': function resize() {
- return {
- 'width': window.outerWidth,
- 'height': window.outerHeight
- };
- }
- };
- refreshEvents = {
- 'submit': null
- };
-}
-
-/**
- * Hooks the event handlers for each event type of interest.
- * @param {Object} config Configuration object to use.
- * @return {boolean} Whether the operation succeeded
- */
-function attachHandlers(config) {
- defineDetails(config);
- Object.keys(events).forEach(function (ev) {
- document.addEventListener(ev, function (e) {
- packageLog(e, events[ev]);
- }, true);
- });
- intervalEvents.forEach(function (ev) {
- document.addEventListener(ev, function (e) {
- packageIntervalLog(e);
- }, true);
- });
- Object.keys(bufferedEvents).forEach(function (ev) {
- bufferBools[ev] = true;
- window.addEventListener(ev, function (e) {
- if (bufferBools[ev]) {
- bufferBools[ev] = false;
- packageLog(e, bufferedEvents[ev]);
- setTimeout(function () {
- bufferBools[ev] = true;
- }, config.resolution);
- }
- }, true);
- });
- Object.keys(refreshEvents).forEach(function (ev) {
- document.addEventListener(ev, function (e) {
- packageLog(e, events[ev]);
- }, true);
- });
- windowEvents.forEach(function (ev) {
- window.addEventListener(ev, function (e) {
- packageLog(e, function () {
- return {
- 'window': true
- };
- });
- }, true);
- });
- return true;
-}
-
-function _arrayWithHoles(arr) {
- if (Array.isArray(arr)) return arr;
-}
-
-function _iterableToArrayLimit(r, l) {
- var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"];
- if (null != t) {
- var e,
- n,
- i,
- u,
- a = [],
- f = !0,
- o = !1;
- try {
- if (i = (t = t.call(r)).next, 0 === l) {
- if (Object(t) !== t) return;
- f = !1;
- } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0);
- } catch (r) {
- o = !0, n = r;
- } finally {
- try {
- if (!f && null != t["return"] && (u = t["return"](), Object(u) !== u)) return;
- } finally {
- if (o) throw n;
- }
- }
- return a;
- }
-}
-
-function _arrayLikeToArray(arr, len) {
- if (len == null || len > arr.length) len = arr.length;
- for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i];
- return arr2;
-}
-
-function _unsupportedIterableToArray(o, minLen) {
- if (!o) return;
- if (typeof o === "string") return _arrayLikeToArray(o, minLen);
- var n = Object.prototype.toString.call(o).slice(8, -1);
- if (n === "Object" && o.constructor) n = o.constructor.name;
- if (n === "Map" || n === "Set") return Array.from(o);
- if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen);
-}
-
-function _nonIterableRest() {
- throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
-}
-
-function _slicedToArray(arr, i) {
- return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest();
-}
-
-var sendIntervalId = null;
-
-/**
- * Initializes the log queue processors.
- * @param {Array} logs Array of logs to append to.
- * @param {Object} config Configuration object to use when logging.
- */
-function initSender(logs, config) {
- if (sendIntervalId !== null) {
- clearInterval(sendIntervalId);
- }
- sendIntervalId = sendOnInterval(logs, config);
- sendOnClose(logs, config);
-}
-
-/**
- * Checks the provided log array on an interval, flushing the logs
- * if the queue has reached the threshold specified by the provided config.
- * @param {Array} logs Array of logs to read from.
- * @param {Object} config Configuration object to be read from.
- * @return {Number} The newly created interval id.
- */
-function sendOnInterval(logs, config) {
- return setInterval(function () {
- if (!config.on) {
- return;
- }
- if (logs.length >= config.logCountThreshold) {
- sendLogs(logs.slice(0), config, 0); // Send a copy
- logs.splice(0); // Clear array reference (no reassignment)
- }
- }, config.transmitInterval);
-}
-
-/**
- * Attempts to flush the remaining logs when the window is closed.
- * @param {Array} logs Array of logs to be flushed.
- * @param {Object} config Configuration object to be read from.
- */
-function sendOnClose(logs, config) {
- window.addEventListener("pagehide", function () {
- if (config.on && logs.length > 0) {
- // NOTE: sendBeacon does not support auth headers,
- // so this will fail if auth is required.
- // The alternative is to use fetch() with keepalive: true
- // https://developer.mozilla.org/en-US/docs/Web/API/Navigator/sendBeacon#description
- // https://stackoverflow.com/a/73062712/9263449
- navigator.sendBeacon(config.url, JSON.stringify(logs));
- logs.splice(0); // clear log queue
- }
- });
-}
-
-/**
- * Sends the provided array of logs to the specified url,
- * retrying the request up to the specified number of retries.
- * @param {Array} logs Array of logs to send.
- * @param {string} config configuration parameters (e.g., to extract URL from & send the POST request to).
- * @param {Number} retries Maximum number of attempts to send the logs.
- */
-
-// @todo expose config object to sendLogs replate url with config.url
-function sendLogs(logs, config, retries) {
- var req = new XMLHttpRequest();
- var data = JSON.stringify(logs);
- req.open("POST", config.url);
- if (config.authHeader) {
- req.setRequestHeader("Authorization", config.authHeader);
- }
- req.setRequestHeader("Content-type", "application/json;charset=UTF-8");
- if (config.headers) {
- Object.entries(config.headers).forEach(function (_ref) {
- var _ref2 = _slicedToArray(_ref, 2),
- header = _ref2[0],
- value = _ref2[1];
- req.setRequestHeader(header, value);
- });
- }
- req.onreadystatechange = function () {
- if (req.readyState === 4 && req.status !== 200) {
- if (retries > 0) {
- sendLogs(logs, config, retries--);
- }
- }
- };
- req.send(data);
-}
-
-var config = {};
-var logs = [];
-var startLoadTimestamp = Date.now();
-var endLoadTimestamp;
-window.onload = function () {
- endLoadTimestamp = Date.now();
-};
-var started = false;
-
-// Start up Userale
-config.on = false;
-config.useraleVersion = version;
-configure(config, getInitialSettings());
-initPackager(logs, config);
-if (config.autostart) {
- setup(config);
-}
-
-/**
- * Hooks the global event listener, and starts up the
- * logging interval.
- * @param {Object} config Configuration settings for the logger
- */
-function setup(config) {
- if (!started) {
- setTimeout(function () {
- var state = document.readyState;
- if (config.autostart && (state === 'interactive' || state === 'complete')) {
- attachHandlers(config);
- initSender(logs, config);
- started = config.on = true;
- packageCustomLog({
- type: 'load',
- details: {
- pageLoadTime: endLoadTimestamp - startLoadTimestamp
- }
- }, function () {}, false);
- } else {
- setup(config);
- }
- }, 100);
- }
-}
-
-/**
- * Updates the current configuration
- * object with the provided values.
- * @param {Object} newConfig The configuration options to use.
- * @return {Object} Returns the updated configuration.
- */
-function options(newConfig) {
- if (newConfig !== undefined) {
- configure(config, newConfig);
- }
- return config;
-}
-
-/*
-* Licensed to the Apache Software Foundation (ASF) under one or more
-* contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
-* The ASF licenses this file to You under the Apache License, Version 2.0
-* (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
-
-
-// browser is defined in firefox, but chrome uses the 'chrome' global.
-var browser = browser || chrome;
-function rerouteLog(log) {
- console.log("reroute");
- browser.runtime.sendMessage({
- type: ADD_LOG,
- payload: log
- });
- return false;
-}
-
-/* eslint-enable */
-
-/*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-browser.storage.local.get("useraleConfig", function (res) {
- options(res.useraleConfig);
- addCallbacks({
- rerouteLog: rerouteLog
- });
-});
-browser.runtime.onMessage.addListener(function (message) {
- if (message.type === CONFIG_CHANGE) {
- options(message.payload);
- }
-});
-
-/*
- eslint-enable
- */
diff --git a/build/UserALEWebExtension/icons/border-48.png b/build/UserALEWebExtension/icons/border-48.png
deleted file mode 100644
index 90687de..0000000
--- a/build/UserALEWebExtension/icons/border-48.png
+++ /dev/null
Binary files differ
diff --git a/build/UserALEWebExtension/manifest.json b/build/UserALEWebExtension/manifest.json
deleted file mode 100644
index ca26fdc..0000000
--- a/build/UserALEWebExtension/manifest.json
+++ /dev/null
@@ -1,30 +0,0 @@
-{
- "manifest_version": 2,
- "name": "User ALE Extension",
- "version": "2.4.0",
- "description": "Injects UserALE.js into every page for testing & user research purposes",
- "icons": {
- "48": "icons/border-48.png"
- },
- "permissions": [
- "activeTab",
- "storage",
- "tabs",
- "<all_urls>"
- ],
- "background": {
- "scripts": ["background.js"]
- },
- "content_scripts": [
- {
- "matches": [
- "<all_urls>"
- ],
- "js": ["content.js"],
- "all_frames": true
- }
- ],
- "options_ui": {
- "page": "optionsPage.html"
- }
-}
\ No newline at end of file
diff --git a/build/UserALEWebExtension/options.js b/build/UserALEWebExtension/options.js
deleted file mode 100644
index ba97986..0000000
--- a/build/UserALEWebExtension/options.js
+++ /dev/null
@@ -1,1176 +0,0 @@
-/*
-* Licensed to the Apache Software Foundation (ASF) under one or more
-* contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
-* The ASF licenses this file to You under the Apache License, Version 2.0
-* (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
-
-var prefix = 'USERALE_';
-var CONFIG_CHANGE = prefix + 'CONFIG_CHANGE';
-var ADD_LOG = prefix + 'ADD_LOG';
-
-var version = "2.4.0";
-
-/*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the 'License'); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an 'AS IS' BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-var sessionId = null;
-
-/**
- * Extracts the initial configuration settings from the
- * currently executing script tag.
- * @return {Object} The extracted configuration object
- */
-function getInitialSettings() {
- var settings = {};
- if (sessionId === null) {
- sessionId = getSessionId('userAleSessionId', 'session_' + String(Date.now()));
- }
- var script = document.currentScript || function () {
- var scripts = document.getElementsByTagName('script');
- return scripts[scripts.length - 1];
- }();
- var get = script ? script.getAttribute.bind(script) : function () {
- return null;
- };
- settings.autostart = get('data-autostart') === 'false' ? false : true;
- settings.url = get('data-url') || 'http://localhost:8000';
- settings.transmitInterval = +get('data-interval') || 5000;
- settings.logCountThreshold = +get('data-threshold') || 5;
- settings.userId = get('data-user') || null;
- settings.version = get('data-version') || null;
- settings.logDetails = get('data-log-details') === 'true' ? true : false;
- settings.resolution = +get('data-resolution') || 500;
- settings.toolName = get('data-tool') || null;
- settings.userFromParams = get('data-user-from-params') || null;
- settings.time = timeStampScale(document.createEvent('CustomEvent'));
- settings.sessionID = get('data-session') || sessionId;
- settings.authHeader = get('data-auth') || null;
- settings.custIndex = get('data-index') || null;
- settings.headers = get('data-headers') || null;
- return settings;
-}
-
-/**
- * defines sessionId, stores it in sessionStorage, checks to see if there is a sessionId in
- * storage when script is started. This prevents events like 'submit', which refresh page data
- * from refreshing the current user session
- *
- */
-function getSessionId(sessionKey, value) {
- if (window.sessionStorage.getItem(sessionKey) === null) {
- window.sessionStorage.setItem(sessionKey, JSON.stringify(value));
- return value;
- }
- return JSON.parse(window.sessionStorage.getItem(sessionKey));
-}
-
-/**
- * Creates a function to normalize the timestamp of the provided event.
- * @param {Object} e An event containing a timeStamp property.
- * @return {timeStampScale~tsScaler} The timestamp normalizing function.
- */
-function timeStampScale(e) {
- var tsScaler;
- if (e.timeStamp && e.timeStamp > 0) {
- var delta = Date.now() - e.timeStamp;
- /**
- * Returns a timestamp depending on various browser quirks.
- * @param {?Number} ts A timestamp to use for normalization.
- * @return {Number} A normalized timestamp.
- */
-
- if (delta < 0) {
- tsScaler = function tsScaler() {
- return e.timeStamp / 1000;
- };
- } else if (delta > e.timeStamp) {
- var navStart = performance.timing.navigationStart;
- tsScaler = function tsScaler(ts) {
- return ts + navStart;
- };
- } else {
- tsScaler = function tsScaler(ts) {
- return ts;
- };
- }
- } else {
- tsScaler = function tsScaler() {
- return Date.now();
- };
- }
- return tsScaler;
-}
-
-/*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-/**
- * Shallow merges the first argument with the second.
- * Retrieves/updates the userid if userFromParams is provided.
- * @param {Object} config Current configuration object to be merged into.
- * @param {Object} newConfig Configuration object to merge into the current config.
- */
-function configure(config, newConfig) {
- var configAutostart = config['autostart'];
- var newConfigAutostart = newConfig['autostart'];
- Object.keys(newConfig).forEach(function (option) {
- if (option === 'userFromParams') {
- var userId = getUserIdFromParams(newConfig[option]);
- if (userId) {
- config.userId = userId;
- }
- }
- config[option] = newConfig[option];
- });
- if (configAutostart === false || newConfigAutostart === false) {
- config['autostart'] = false;
- }
-}
-
-/**
- * Attempts to extract the userid from the query parameters of the URL.
- * @param {string} param The name of the query parameter containing the userid.
- * @return {string|null} The extracted/decoded userid, or null if none is found.
- */
-function getUserIdFromParams(param) {
- var userField = param;
- var regex = new RegExp('[?&]' + userField + '(=([^&#]*)|&|#|$)');
- var results = window.location.href.match(regex);
- if (results && results[2]) {
- return decodeURIComponent(results[2].replace(/\+/g, ' '));
- } else {
- return null;
- }
-}
-
-var __spreadArray = (undefined && undefined.__spreadArray) || function (to, from, pack) {
- if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
- if (ar || !(i in from)) {
- if (!ar) ar = Array.prototype.slice.call(from, 0, i);
- ar[i] = from[i];
- }
- }
- return to.concat(ar || Array.prototype.slice.call(from));
-};
-var BrowserInfo = /** @class */ (function () {
- function BrowserInfo(name, version, os) {
- this.name = name;
- this.version = version;
- this.os = os;
- this.type = 'browser';
- }
- return BrowserInfo;
-}());
-var NodeInfo = /** @class */ (function () {
- function NodeInfo(version) {
- this.version = version;
- this.type = 'node';
- this.name = 'node';
- this.os = process.platform;
- }
- return NodeInfo;
-}());
-var SearchBotDeviceInfo = /** @class */ (function () {
- function SearchBotDeviceInfo(name, version, os, bot) {
- this.name = name;
- this.version = version;
- this.os = os;
- this.bot = bot;
- this.type = 'bot-device';
- }
- return SearchBotDeviceInfo;
-}());
-var BotInfo = /** @class */ (function () {
- function BotInfo() {
- this.type = 'bot';
- this.bot = true; // NOTE: deprecated test name instead
- this.name = 'bot';
- this.version = null;
- this.os = null;
- }
- return BotInfo;
-}());
-var ReactNativeInfo = /** @class */ (function () {
- function ReactNativeInfo() {
- this.type = 'react-native';
- this.name = 'react-native';
- this.version = null;
- this.os = null;
- }
- return ReactNativeInfo;
-}());
-// tslint:disable-next-line:max-line-length
-var SEARCHBOX_UA_REGEX = /alexa|bot|crawl(er|ing)|facebookexternalhit|feedburner|google web preview|nagios|postrank|pingdom|slurp|spider|yahoo!|yandex/;
-var SEARCHBOT_OS_REGEX = /(nuhk|curl|Googlebot|Yammybot|Openbot|Slurp|MSNBot|Ask\ Jeeves\/Teoma|ia_archiver)/;
-var REQUIRED_VERSION_PARTS = 3;
-var userAgentRules = [
- ['aol', /AOLShield\/([0-9\._]+)/],
- ['edge', /Edge\/([0-9\._]+)/],
- ['edge-ios', /EdgiOS\/([0-9\._]+)/],
- ['yandexbrowser', /YaBrowser\/([0-9\._]+)/],
- ['kakaotalk', /KAKAOTALK\s([0-9\.]+)/],
- ['samsung', /SamsungBrowser\/([0-9\.]+)/],
- ['silk', /\bSilk\/([0-9._-]+)\b/],
- ['miui', /MiuiBrowser\/([0-9\.]+)$/],
- ['beaker', /BeakerBrowser\/([0-9\.]+)/],
- ['edge-chromium', /EdgA?\/([0-9\.]+)/],
- [
- 'chromium-webview',
- /(?!Chrom.*OPR)wv\).*Chrom(?:e|ium)\/([0-9\.]+)(:?\s|$)/,
- ],
- ['chrome', /(?!Chrom.*OPR)Chrom(?:e|ium)\/([0-9\.]+)(:?\s|$)/],
- ['phantomjs', /PhantomJS\/([0-9\.]+)(:?\s|$)/],
- ['crios', /CriOS\/([0-9\.]+)(:?\s|$)/],
- ['firefox', /Firefox\/([0-9\.]+)(?:\s|$)/],
- ['fxios', /FxiOS\/([0-9\.]+)/],
- ['opera-mini', /Opera Mini.*Version\/([0-9\.]+)/],
- ['opera', /Opera\/([0-9\.]+)(?:\s|$)/],
- ['opera', /OPR\/([0-9\.]+)(:?\s|$)/],
- ['pie', /^Microsoft Pocket Internet Explorer\/(\d+\.\d+)$/],
- ['pie', /^Mozilla\/\d\.\d+\s\(compatible;\s(?:MSP?IE|MSInternet Explorer) (\d+\.\d+);.*Windows CE.*\)$/],
- ['netfront', /^Mozilla\/\d\.\d+.*NetFront\/(\d.\d)/],
- ['ie', /Trident\/7\.0.*rv\:([0-9\.]+).*\).*Gecko$/],
- ['ie', /MSIE\s([0-9\.]+);.*Trident\/[4-7].0/],
- ['ie', /MSIE\s(7\.0)/],
- ['bb10', /BB10;\sTouch.*Version\/([0-9\.]+)/],
- ['android', /Android\s([0-9\.]+)/],
- ['ios', /Version\/([0-9\._]+).*Mobile.*Safari.*/],
- ['safari', /Version\/([0-9\._]+).*Safari/],
- ['facebook', /FB[AS]V\/([0-9\.]+)/],
- ['instagram', /Instagram\s([0-9\.]+)/],
- ['ios-webview', /AppleWebKit\/([0-9\.]+).*Mobile/],
- ['ios-webview', /AppleWebKit\/([0-9\.]+).*Gecko\)$/],
- ['curl', /^curl\/([0-9\.]+)$/],
- ['searchbot', SEARCHBOX_UA_REGEX],
-];
-var operatingSystemRules = [
- ['iOS', /iP(hone|od|ad)/],
- ['Android OS', /Android/],
- ['BlackBerry OS', /BlackBerry|BB10/],
- ['Windows Mobile', /IEMobile/],
- ['Amazon OS', /Kindle/],
- ['Windows 3.11', /Win16/],
- ['Windows 95', /(Windows 95)|(Win95)|(Windows_95)/],
- ['Windows 98', /(Windows 98)|(Win98)/],
- ['Windows 2000', /(Windows NT 5.0)|(Windows 2000)/],
- ['Windows XP', /(Windows NT 5.1)|(Windows XP)/],
- ['Windows Server 2003', /(Windows NT 5.2)/],
- ['Windows Vista', /(Windows NT 6.0)/],
- ['Windows 7', /(Windows NT 6.1)/],
- ['Windows 8', /(Windows NT 6.2)/],
- ['Windows 8.1', /(Windows NT 6.3)/],
- ['Windows 10', /(Windows NT 10.0)/],
- ['Windows ME', /Windows ME/],
- ['Windows CE', /Windows CE|WinCE|Microsoft Pocket Internet Explorer/],
- ['Open BSD', /OpenBSD/],
- ['Sun OS', /SunOS/],
- ['Chrome OS', /CrOS/],
- ['Linux', /(Linux)|(X11)/],
- ['Mac OS', /(Mac_PowerPC)|(Macintosh)/],
- ['QNX', /QNX/],
- ['BeOS', /BeOS/],
- ['OS/2', /OS\/2/],
-];
-function detect(userAgent) {
- if (!!userAgent) {
- return parseUserAgent(userAgent);
- }
- if (typeof document === 'undefined' &&
- typeof navigator !== 'undefined' &&
- navigator.product === 'ReactNative') {
- return new ReactNativeInfo();
- }
- if (typeof navigator !== 'undefined') {
- return parseUserAgent(navigator.userAgent);
- }
- return getNodeVersion();
-}
-function matchUserAgent(ua) {
- // opted for using reduce here rather than Array#first with a regex.test call
- // this is primarily because using the reduce we only perform the regex
- // execution once rather than once for the test and for the exec again below
- // probably something that needs to be benchmarked though
- return (ua !== '' &&
- userAgentRules.reduce(function (matched, _a) {
- var browser = _a[0], regex = _a[1];
- if (matched) {
- return matched;
- }
- var uaMatch = regex.exec(ua);
- return !!uaMatch && [browser, uaMatch];
- }, false));
-}
-function parseUserAgent(ua) {
- var matchedRule = matchUserAgent(ua);
- if (!matchedRule) {
- return null;
- }
- var name = matchedRule[0], match = matchedRule[1];
- if (name === 'searchbot') {
- return new BotInfo();
- }
- // Do not use RegExp for split operation as some browser do not support it (See: http://blog.stevenlevithan.com/archives/cross-browser-split)
- var versionParts = match[1] && match[1].split('.').join('_').split('_').slice(0, 3);
- if (versionParts) {
- if (versionParts.length < REQUIRED_VERSION_PARTS) {
- versionParts = __spreadArray(__spreadArray([], versionParts, true), createVersionParts(REQUIRED_VERSION_PARTS - versionParts.length), true);
- }
- }
- else {
- versionParts = [];
- }
- var version = versionParts.join('.');
- var os = detectOS(ua);
- var searchBotMatch = SEARCHBOT_OS_REGEX.exec(ua);
- if (searchBotMatch && searchBotMatch[1]) {
- return new SearchBotDeviceInfo(name, version, os, searchBotMatch[1]);
- }
- return new BrowserInfo(name, version, os);
-}
-function detectOS(ua) {
- for (var ii = 0, count = operatingSystemRules.length; ii < count; ii++) {
- var _a = operatingSystemRules[ii], os = _a[0], regex = _a[1];
- var match = regex.exec(ua);
- if (match) {
- return os;
- }
- }
- return null;
-}
-function getNodeVersion() {
- var isNode = typeof process !== 'undefined' && process.version;
- return isNode ? new NodeInfo(process.version.slice(1)) : null;
-}
-function createVersionParts(count) {
- var output = [];
- for (var ii = 0; ii < count; ii++) {
- output.push('0');
- }
- return output;
-}
-
-/*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-var browserInfo = detect();
-var logs$1;
-var config$1;
-
-// Interval Logging Globals
-var intervalID;
-var intervalType;
-var intervalPath;
-var intervalTimer;
-var intervalCounter;
-var intervalLog;
-var cbHandlers = {};
-
-/**
- * Adds named callbacks to be executed when logging.
- * @param {Object } newCallbacks An object containing named callback functions.
- */
-function addCallbacks() {
- for (var _len = arguments.length, newCallbacks = new Array(_len), _key = 0; _key < _len; _key++) {
- newCallbacks[_key] = arguments[_key];
- }
- newCallbacks.forEach(function (source) {
- var descriptors = Object.keys(source).reduce(function (descriptors, key) {
- descriptors[key] = Object.getOwnPropertyDescriptor(source, key);
- return descriptors;
- }, {});
- Object.getOwnPropertySymbols(source).forEach(function (sym) {
- var descriptor = Object.getOwnPropertyDescriptor(source, sym);
- if (descriptor.enumerable) {
- descriptors[sym] = descriptor;
- }
- });
- Object.defineProperties(cbHandlers, descriptors);
- });
- return cbHandlers;
-}
-
-/**
- * Assigns the config and log container to be used by the logging functions.
- * @param {Array} newLogs Log container.
- * @param {Object} newConfig Configuration to use while logging.
- */
-function initPackager(newLogs, newConfig) {
- logs$1 = newLogs;
- config$1 = newConfig;
- cbHandlers = [];
- intervalID = null;
- intervalType = null;
- intervalPath = null;
- intervalTimer = null;
- intervalCounter = 0;
- intervalLog = null;
-}
-
-/**
- * Transforms the provided HTML event into a log and appends it to the log queue.
- * @param {Object} e The event to be logged.
- * @param {Function} detailFcn The function to extract additional log parameters from the event.
- * @return {boolean} Whether the event was logged.
- */
-function packageLog(e, detailFcn) {
- if (!config$1.on) {
- return false;
- }
- var details = null;
- if (detailFcn) {
- details = detailFcn(e);
- }
- var timeFields = extractTimeFields(e.timeStamp && e.timeStamp > 0 ? config$1.time(e.timeStamp) : Date.now());
- var log = {
- 'target': getSelector(e.target),
- 'path': buildPath(e),
- 'pageUrl': window.location.href,
- 'pageTitle': document.title,
- 'pageReferrer': document.referrer,
- 'browser': detectBrowser(),
- 'clientTime': timeFields.milli,
- 'microTime': timeFields.micro,
- 'location': getLocation(e),
- 'scrnRes': getSreenRes(),
- 'type': e.type,
- 'logType': 'raw',
- 'userAction': true,
- 'details': details,
- 'userId': config$1.userId,
- 'toolVersion': config$1.version,
- 'toolName': config$1.toolName,
- 'useraleVersion': config$1.useraleVersion,
- 'sessionID': config$1.sessionID
- };
- for (var _i = 0, _Object$values = Object.values(cbHandlers); _i < _Object$values.length; _i++) {
- var func = _Object$values[_i];
- if (typeof func === 'function') {
- log = func(log, e);
- if (!log) {
- return false;
- }
- }
- }
- logs$1.push(log);
- return true;
-}
-
-/**
- * Packages the provided customLog to include standard meta data and appends it to the log queue.
- * @param {Object} customLog The behavior to be logged.
- * @param {Function} detailFcn The function to extract additional log parameters from the event.
- * @param {boolean} userAction Indicates user behavior (true) or system behavior (false)
- * @return {boolean} Whether the event was logged.
- */
-function packageCustomLog(customLog, detailFcn, userAction) {
- if (!config$1.on) {
- return false;
- }
- var details = null;
- if (detailFcn) {
- details = detailFcn();
- }
- var metaData = {
- 'pageUrl': window.location.href,
- 'pageTitle': document.title,
- 'pageReferrer': document.referrer,
- 'browser': detectBrowser(),
- 'clientTime': Date.now(),
- 'scrnRes': getSreenRes(),
- 'logType': 'custom',
- 'userAction': userAction,
- 'details': details,
- 'userId': config$1.userId,
- 'toolVersion': config$1.version,
- 'toolName': config$1.toolName,
- 'useraleVersion': config$1.useraleVersion,
- 'sessionID': config$1.sessionID
- };
- var log = Object.assign(metaData, customLog);
- for (var _i2 = 0, _Object$values2 = Object.values(cbHandlers); _i2 < _Object$values2.length; _i2++) {
- var func = _Object$values2[_i2];
- if (typeof func === 'function') {
- log = func(log, null);
- if (!log) {
- return false;
- }
- }
- }
- logs$1.push(log);
- return true;
-}
-
-/**
- * Extract the millisecond and microsecond portions of a timestamp.
- * @param {Number} timeStamp The timestamp to split into millisecond and microsecond fields.
- * @return {Object} An object containing the millisecond
- * and microsecond portions of the timestamp.
- */
-function extractTimeFields(timeStamp) {
- return {
- milli: Math.floor(timeStamp),
- micro: Number((timeStamp % 1).toFixed(3))
- };
-}
-
-/**
- * Track intervals and gather details about it.
- * @param {Object} e
- * @return boolean
- */
-function packageIntervalLog(e) {
- var target = getSelector(e.target);
- var path = buildPath(e);
- var type = e.type;
- var timestamp = Math.floor(e.timeStamp && e.timeStamp > 0 ? config$1.time(e.timeStamp) : Date.now());
-
- // Init - this should only happen once on initialization
- if (intervalID == null) {
- intervalID = target;
- intervalType = type;
- intervalPath = path;
- intervalTimer = timestamp;
- intervalCounter = 0;
- }
- if (intervalID !== target || intervalType !== type) {
- // When to create log? On transition end
- // @todo Possible for intervalLog to not be pushed in the event the interval never ends...
-
- intervalLog = {
- 'target': intervalID,
- 'path': intervalPath,
- 'pageUrl': window.location.href,
- 'pageTitle': document.title,
- 'pageReferrer': document.referrer,
- 'browser': detectBrowser(),
- 'count': intervalCounter,
- 'duration': timestamp - intervalTimer,
- // microseconds
- 'startTime': intervalTimer,
- 'endTime': timestamp,
- 'type': intervalType,
- 'logType': 'interval',
- 'targetChange': intervalID !== target,
- 'typeChange': intervalType !== type,
- 'userAction': false,
- 'userId': config$1.userId,
- 'toolVersion': config$1.version,
- 'toolName': config$1.toolName,
- 'useraleVersion': config$1.useraleVersion,
- 'sessionID': config$1.sessionID
- };
- for (var _i3 = 0, _Object$values3 = Object.values(cbHandlers); _i3 < _Object$values3.length; _i3++) {
- var func = _Object$values3[_i3];
- if (typeof func === 'function') {
- intervalLog = func(intervalLog, null);
- if (!intervalLog) {
- return false;
- }
- }
- }
- logs$1.push(intervalLog);
-
- // Reset
- intervalID = target;
- intervalType = type;
- intervalPath = path;
- intervalTimer = timestamp;
- intervalCounter = 0;
- }
-
- // Interval is still occuring, just update counter
- if (intervalID == target && intervalType == type) {
- intervalCounter = intervalCounter + 1;
- }
- return true;
-}
-
-/**
- * Extracts coordinate information from the event
- * depending on a few browser quirks.
- * @param {Object} e The event to extract coordinate information from.
- * @return {Object} An object containing nullable x and y coordinates for the event.
- */
-function getLocation(e) {
- if (e.pageX != null) {
- return {
- 'x': e.pageX,
- 'y': e.pageY
- };
- } else if (e.clientX != null) {
- return {
- 'x': document.documentElement.scrollLeft + e.clientX,
- 'y': document.documentElement.scrollTop + e.clientY
- };
- } else {
- return {
- 'x': null,
- 'y': null
- };
- }
-}
-
-/**
- * Extracts innerWidth and innerHeight to provide estimates of screen resolution
- * @return {Object} An object containing the innerWidth and InnerHeight
- */
-function getSreenRes() {
- return {
- 'width': window.innerWidth,
- 'height': window.innerHeight
- };
-}
-
-/**
- * Builds a string CSS selector from the provided element
- * @param {HTMLElement} ele The element from which the selector is built.
- * @return {string} The CSS selector for the element, or Unknown if it can't be determined.
- */
-function getSelector(ele) {
- if (ele.localName) {
- return ele.localName + (ele.id ? '#' + ele.id : '') + (ele.className ? '.' + ele.className : '');
- } else if (ele.nodeName) {
- return ele.nodeName + (ele.id ? '#' + ele.id : '') + (ele.className ? '.' + ele.className : '');
- } else if (ele && ele.document && ele.location && ele.alert && ele.setInterval) {
- return "Window";
- } else {
- return "Unknown";
- }
-}
-
-/**
- * Builds an array of elements from the provided event target, to the root element.
- * @param {Object} e Event from which the path should be built.
- * @return {HTMLElement[]} Array of elements, starting at the event target, ending at the root element.
- */
-function buildPath(e) {
- if (e instanceof window.Event) {
- var path = e.composedPath();
- return selectorizePath(path);
- }
-}
-
-/**
- * Builds a CSS selector path from the provided list of elements.
- * @param {HTMLElement[]} path Array of HTMLElements from which the path should be built.
- * @return {string[]} Array of string CSS selectors.
- */
-function selectorizePath(path) {
- var i = 0;
- var pathEle;
- var pathSelectors = [];
- while (pathEle = path[i]) {
- pathSelectors.push(getSelector(pathEle));
- ++i;
- }
- return pathSelectors;
-}
-function detectBrowser() {
- return {
- 'browser': browserInfo ? browserInfo.name : '',
- 'version': browserInfo ? browserInfo.version : ''
- };
-}
-
-/*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-var events;
-var bufferBools;
-var bufferedEvents;
-//@todo: Investigate drag events and their behavior
-var intervalEvents = ['click', 'focus', 'blur', 'input', 'change', 'mouseover', 'submit'];
-var refreshEvents;
-var windowEvents = ['load', 'blur', 'focus'];
-
-/**
- * Maps an event to an object containing useful information.
- * @param {Object} e Event to extract data from
- */
-function extractMouseEvent(e) {
- return {
- 'clicks': e.detail,
- 'ctrl': e.ctrlKey,
- 'alt': e.altKey,
- 'shift': e.shiftKey,
- 'meta': e.metaKey
- // 'text' : e.target.innerHTML
- };
-}
-
-/**
- * Defines the way information is extracted from various events.
- * Also defines which events we will listen to.
- * @param {Object} config Configuration object to read from.
- */
-function defineDetails(config) {
- // Events list
- // Keys are event types
- // Values are functions that return details object if applicable
- events = {
- 'click': extractMouseEvent,
- 'dblclick': extractMouseEvent,
- 'mousedown': extractMouseEvent,
- 'mouseup': extractMouseEvent,
- 'focus': null,
- 'blur': null,
- 'input': config.logDetails ? function (e) {
- return {
- 'value': e.target.value
- };
- } : null,
- 'change': config.logDetails ? function (e) {
- return {
- 'value': e.target.value
- };
- } : null,
- 'dragstart': null,
- 'dragend': null,
- 'drag': null,
- 'drop': null,
- 'keydown': config.logDetails ? function (e) {
- return {
- 'key': e.keyCode,
- 'ctrl': e.ctrlKey,
- 'alt': e.altKey,
- 'shift': e.shiftKey,
- 'meta': e.metaKey
- };
- } : null,
- 'mouseover': null
- };
- bufferBools = {};
- bufferedEvents = {
- 'wheel': function wheel(e) {
- return {
- 'x': e.deltaX,
- 'y': e.deltaY,
- 'z': e.deltaZ
- };
- },
- 'scroll': function scroll() {
- return {
- 'x': window.scrollX,
- 'y': window.scrollY
- };
- },
- 'resize': function resize() {
- return {
- 'width': window.outerWidth,
- 'height': window.outerHeight
- };
- }
- };
- refreshEvents = {
- 'submit': null
- };
-}
-
-/**
- * Hooks the event handlers for each event type of interest.
- * @param {Object} config Configuration object to use.
- * @return {boolean} Whether the operation succeeded
- */
-function attachHandlers(config) {
- defineDetails(config);
- Object.keys(events).forEach(function (ev) {
- document.addEventListener(ev, function (e) {
- packageLog(e, events[ev]);
- }, true);
- });
- intervalEvents.forEach(function (ev) {
- document.addEventListener(ev, function (e) {
- packageIntervalLog(e);
- }, true);
- });
- Object.keys(bufferedEvents).forEach(function (ev) {
- bufferBools[ev] = true;
- window.addEventListener(ev, function (e) {
- if (bufferBools[ev]) {
- bufferBools[ev] = false;
- packageLog(e, bufferedEvents[ev]);
- setTimeout(function () {
- bufferBools[ev] = true;
- }, config.resolution);
- }
- }, true);
- });
- Object.keys(refreshEvents).forEach(function (ev) {
- document.addEventListener(ev, function (e) {
- packageLog(e, events[ev]);
- }, true);
- });
- windowEvents.forEach(function (ev) {
- window.addEventListener(ev, function (e) {
- packageLog(e, function () {
- return {
- 'window': true
- };
- });
- }, true);
- });
- return true;
-}
-
-function _arrayWithHoles(arr) {
- if (Array.isArray(arr)) return arr;
-}
-
-function _iterableToArrayLimit(r, l) {
- var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"];
- if (null != t) {
- var e,
- n,
- i,
- u,
- a = [],
- f = !0,
- o = !1;
- try {
- if (i = (t = t.call(r)).next, 0 === l) {
- if (Object(t) !== t) return;
- f = !1;
- } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0);
- } catch (r) {
- o = !0, n = r;
- } finally {
- try {
- if (!f && null != t["return"] && (u = t["return"](), Object(u) !== u)) return;
- } finally {
- if (o) throw n;
- }
- }
- return a;
- }
-}
-
-function _arrayLikeToArray(arr, len) {
- if (len == null || len > arr.length) len = arr.length;
- for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i];
- return arr2;
-}
-
-function _unsupportedIterableToArray(o, minLen) {
- if (!o) return;
- if (typeof o === "string") return _arrayLikeToArray(o, minLen);
- var n = Object.prototype.toString.call(o).slice(8, -1);
- if (n === "Object" && o.constructor) n = o.constructor.name;
- if (n === "Map" || n === "Set") return Array.from(o);
- if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen);
-}
-
-function _nonIterableRest() {
- throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
-}
-
-function _slicedToArray(arr, i) {
- return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest();
-}
-
-var sendIntervalId = null;
-
-/**
- * Initializes the log queue processors.
- * @param {Array} logs Array of logs to append to.
- * @param {Object} config Configuration object to use when logging.
- */
-function initSender(logs, config) {
- if (sendIntervalId !== null) {
- clearInterval(sendIntervalId);
- }
- sendIntervalId = sendOnInterval(logs, config);
- sendOnClose(logs, config);
-}
-
-/**
- * Checks the provided log array on an interval, flushing the logs
- * if the queue has reached the threshold specified by the provided config.
- * @param {Array} logs Array of logs to read from.
- * @param {Object} config Configuration object to be read from.
- * @return {Number} The newly created interval id.
- */
-function sendOnInterval(logs, config) {
- return setInterval(function () {
- if (!config.on) {
- return;
- }
- if (logs.length >= config.logCountThreshold) {
- sendLogs(logs.slice(0), config, 0); // Send a copy
- logs.splice(0); // Clear array reference (no reassignment)
- }
- }, config.transmitInterval);
-}
-
-/**
- * Attempts to flush the remaining logs when the window is closed.
- * @param {Array} logs Array of logs to be flushed.
- * @param {Object} config Configuration object to be read from.
- */
-function sendOnClose(logs, config) {
- window.addEventListener("pagehide", function () {
- if (config.on && logs.length > 0) {
- // NOTE: sendBeacon does not support auth headers,
- // so this will fail if auth is required.
- // The alternative is to use fetch() with keepalive: true
- // https://developer.mozilla.org/en-US/docs/Web/API/Navigator/sendBeacon#description
- // https://stackoverflow.com/a/73062712/9263449
- navigator.sendBeacon(config.url, JSON.stringify(logs));
- logs.splice(0); // clear log queue
- }
- });
-}
-
-/**
- * Sends the provided array of logs to the specified url,
- * retrying the request up to the specified number of retries.
- * @param {Array} logs Array of logs to send.
- * @param {string} config configuration parameters (e.g., to extract URL from & send the POST request to).
- * @param {Number} retries Maximum number of attempts to send the logs.
- */
-
-// @todo expose config object to sendLogs replate url with config.url
-function sendLogs(logs, config, retries) {
- var req = new XMLHttpRequest();
- var data = JSON.stringify(logs);
- req.open("POST", config.url);
- if (config.authHeader) {
- req.setRequestHeader("Authorization", config.authHeader);
- }
- req.setRequestHeader("Content-type", "application/json;charset=UTF-8");
- if (config.headers) {
- Object.entries(config.headers).forEach(function (_ref) {
- var _ref2 = _slicedToArray(_ref, 2),
- header = _ref2[0],
- value = _ref2[1];
- req.setRequestHeader(header, value);
- });
- }
- req.onreadystatechange = function () {
- if (req.readyState === 4 && req.status !== 200) {
- if (retries > 0) {
- sendLogs(logs, config, retries--);
- }
- }
- };
- req.send(data);
-}
-
-var config = {};
-var logs = [];
-var startLoadTimestamp = Date.now();
-var endLoadTimestamp;
-window.onload = function () {
- endLoadTimestamp = Date.now();
-};
-var started = false;
-
-// Start up Userale
-config.on = false;
-config.useraleVersion = version;
-configure(config, getInitialSettings());
-initPackager(logs, config);
-if (config.autostart) {
- setup(config);
-}
-
-/**
- * Hooks the global event listener, and starts up the
- * logging interval.
- * @param {Object} config Configuration settings for the logger
- */
-function setup(config) {
- if (!started) {
- setTimeout(function () {
- var state = document.readyState;
- if (config.autostart && (state === 'interactive' || state === 'complete')) {
- attachHandlers(config);
- initSender(logs, config);
- started = config.on = true;
- packageCustomLog({
- type: 'load',
- details: {
- pageLoadTime: endLoadTimestamp - startLoadTimestamp
- }
- }, function () {}, false);
- } else {
- setup(config);
- }
- }, 100);
- }
-}
-
-/**
- * Updates the current configuration
- * object with the provided values.
- * @param {Object} newConfig The configuration options to use.
- * @return {Object} Returns the updated configuration.
- */
-function options(newConfig) {
- if (newConfig !== undefined) {
- configure(config, newConfig);
- }
- return config;
-}
-
-/*
-* Licensed to the Apache Software Foundation (ASF) under one or more
-* contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
-* The ASF licenses this file to You under the Apache License, Version 2.0
-* (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
-
-
-// browser is defined in firefox, but chrome uses the 'chrome' global.
-var browser = browser || chrome;
-function rerouteLog(log) {
- console.log("reroute");
- browser.runtime.sendMessage({
- type: ADD_LOG,
- payload: log
- });
- return false;
-}
-
-/* eslint-enable */
-
-/*
-* Licensed to the Apache Software Foundation (ASF) under one or more
-* contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
-* The ASF licenses this file to You under the Apache License, Version 2.0
-* (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
-
-addCallbacks({
- rerouteLog: rerouteLog
-});
-function setConfig() {
- var config = {
- url: document.getElementById("url").value,
- userId: document.getElementById("user").value,
- toolName: document.getElementById("tool").value,
- version: document.getElementById("version").value
- };
-
- // Set a basic auth header if given credentials.
- var password = document.getElementById("password").value;
- if (config.userId && password) {
- config.authHeader = "Basic " + btoa("".concat(config.userId, ":").concat(password));
- }
- var payload = {
- useraleConfig: config,
- pluginConfig: {
- urlWhitelist: document.getElementById("filter").value
- }
- };
- browser.storage.local.set(payload, function () {
- options(config);
- browser.runtime.sendMessage({
- type: CONFIG_CHANGE,
- payload: payload
- });
- });
-}
-function getConfig() {
- browser.storage.local.get("useraleConfig", function (res) {
- var config = res.useraleConfig;
- options(config);
- document.getElementById("url").value = config.url;
- document.getElementById("user").value = config.userId;
- document.getElementById("tool").value = config.toolName;
- document.getElementById("version").value = config.version;
- });
- browser.storage.local.get("pluginConfig", function (res) {
- document.getElementById("filter").value = res.pluginConfig.urlWhitelist;
- });
-}
-document.addEventListener("DOMContentLoaded", getConfig);
-document.addEventListener("submit", setConfig);
-
-/* eslint-enable */
diff --git a/build/UserALEWebExtension/optionsPage.html b/build/UserALEWebExtension/optionsPage.html
deleted file mode 100644
index 9a3f363..0000000
--- a/build/UserALEWebExtension/optionsPage.html
+++ /dev/null
@@ -1,57 +0,0 @@
-<!--
-* Licensed to the Apache Software Foundation (ASF) under one or more
-* contributor license agreements. See the NOTICE file distributed with
-* this work for additional information regarding copyright ownership.
-* The ASF licenses this file to You under the Apache License, Version 2.0
-* (the "License"); you may not use this file except in compliance with
-* the License. You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
--->
-
-<!DOCTYPE html>
-<html>
-<head>
- <title>User ALE Web Extension - Options</title>
- <script src="options.js"></script>
- <meta charset="utf-8">
-</head>
-<body>
-<h1>Options</h1>
-<form>
- <label>Logging Endpoint URL:</label>
- <input id="url"/>
- <br/>
-
- <label>User:</label>
- <input id="user"/>
- <br/>
-
- <label>Password:</label>
- <input type="password" id="password"/>
- <br/>
-
- <label>Tool Name:</label>
- <input id="tool"/>
- <br/>
-
- <label>Tool Version:</label>
- <input id="version"/>
- <br/>
-
- <label>URL whitelist regex:</label>
- <input id="filter"/>
- <br/>
-
- <div align="right">
- <button type="submit">Save</button>
- </div>
-</form>
-</body>
-</html>
\ No newline at end of file
diff --git a/build/userale-2.4.0.js b/build/userale-2.4.0.js
deleted file mode 100644
index 5fc18af..0000000
--- a/build/userale-2.4.0.js
+++ /dev/null
@@ -1,1295 +0,0 @@
-/**
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * @preserved
- */
-
-(function (global, factory) {
- typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports) :
- typeof define === 'function' && define.amd ? define(['exports'], factory) :
- (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.userale = {}));
-})(this, (function (exports) { 'use strict';
-
- function _typeof(o) {
- "@babel/helpers - typeof";
-
- return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) {
- return typeof o;
- } : function (o) {
- return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o;
- }, _typeof(o);
- }
-
- var version$1 = "2.4.0";
-
- /*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the 'License'); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an 'AS IS' BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
- var sessionId = null;
-
- /**
- * Extracts the initial configuration settings from the
- * currently executing script tag.
- * @return {Object} The extracted configuration object
- */
- function getInitialSettings() {
- var settings = {};
- if (sessionId === null) {
- sessionId = getSessionId('userAleSessionId', 'session_' + String(Date.now()));
- }
- var script = document.currentScript || function () {
- var scripts = document.getElementsByTagName('script');
- return scripts[scripts.length - 1];
- }();
- var get = script ? script.getAttribute.bind(script) : function () {
- return null;
- };
- settings.autostart = get('data-autostart') === 'false' ? false : true;
- settings.url = get('data-url') || 'http://localhost:8000';
- settings.transmitInterval = +get('data-interval') || 5000;
- settings.logCountThreshold = +get('data-threshold') || 5;
- settings.userId = get('data-user') || null;
- settings.version = get('data-version') || null;
- settings.logDetails = get('data-log-details') === 'true' ? true : false;
- settings.resolution = +get('data-resolution') || 500;
- settings.toolName = get('data-tool') || null;
- settings.userFromParams = get('data-user-from-params') || null;
- settings.time = timeStampScale(document.createEvent('CustomEvent'));
- settings.sessionID = get('data-session') || sessionId;
- settings.authHeader = get('data-auth') || null;
- settings.custIndex = get('data-index') || null;
- settings.headers = get('data-headers') || null;
- return settings;
- }
-
- /**
- * defines sessionId, stores it in sessionStorage, checks to see if there is a sessionId in
- * storage when script is started. This prevents events like 'submit', which refresh page data
- * from refreshing the current user session
- *
- */
- function getSessionId(sessionKey, value) {
- if (window.sessionStorage.getItem(sessionKey) === null) {
- window.sessionStorage.setItem(sessionKey, JSON.stringify(value));
- return value;
- }
- return JSON.parse(window.sessionStorage.getItem(sessionKey));
- }
-
- /**
- * Creates a function to normalize the timestamp of the provided event.
- * @param {Object} e An event containing a timeStamp property.
- * @return {timeStampScale~tsScaler} The timestamp normalizing function.
- */
- function timeStampScale(e) {
- var tsScaler;
- if (e.timeStamp && e.timeStamp > 0) {
- var delta = Date.now() - e.timeStamp;
- /**
- * Returns a timestamp depending on various browser quirks.
- * @param {?Number} ts A timestamp to use for normalization.
- * @return {Number} A normalized timestamp.
- */
-
- if (delta < 0) {
- tsScaler = function tsScaler() {
- return e.timeStamp / 1000;
- };
- } else if (delta > e.timeStamp) {
- var navStart = performance.timing.navigationStart;
- tsScaler = function tsScaler(ts) {
- return ts + navStart;
- };
- } else {
- tsScaler = function tsScaler(ts) {
- return ts;
- };
- }
- } else {
- tsScaler = function tsScaler() {
- return Date.now();
- };
- }
- return tsScaler;
- }
-
- /*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
- /**
- * Shallow merges the first argument with the second.
- * Retrieves/updates the userid if userFromParams is provided.
- * @param {Object} config Current configuration object to be merged into.
- * @param {Object} newConfig Configuration object to merge into the current config.
- */
- function configure(config, newConfig) {
- var configAutostart = config['autostart'];
- var newConfigAutostart = newConfig['autostart'];
- Object.keys(newConfig).forEach(function (option) {
- if (option === 'userFromParams') {
- var userId = getUserIdFromParams(newConfig[option]);
- if (userId) {
- config.userId = userId;
- }
- }
- config[option] = newConfig[option];
- });
- if (configAutostart === false || newConfigAutostart === false) {
- config['autostart'] = false;
- }
- }
-
- /**
- * Attempts to extract the userid from the query parameters of the URL.
- * @param {string} param The name of the query parameter containing the userid.
- * @return {string|null} The extracted/decoded userid, or null if none is found.
- */
- function getUserIdFromParams(param) {
- var userField = param;
- var regex = new RegExp('[?&]' + userField + '(=([^&#]*)|&|#|$)');
- var results = window.location.href.match(regex);
- if (results && results[2]) {
- return decodeURIComponent(results[2].replace(/\+/g, ' '));
- } else {
- return null;
- }
- }
-
- var __spreadArray = (undefined && undefined.__spreadArray) || function (to, from, pack) {
- if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
- if (ar || !(i in from)) {
- if (!ar) ar = Array.prototype.slice.call(from, 0, i);
- ar[i] = from[i];
- }
- }
- return to.concat(ar || Array.prototype.slice.call(from));
- };
- var BrowserInfo = /** @class */ (function () {
- function BrowserInfo(name, version, os) {
- this.name = name;
- this.version = version;
- this.os = os;
- this.type = 'browser';
- }
- return BrowserInfo;
- }());
- var NodeInfo = /** @class */ (function () {
- function NodeInfo(version) {
- this.version = version;
- this.type = 'node';
- this.name = 'node';
- this.os = process.platform;
- }
- return NodeInfo;
- }());
- var SearchBotDeviceInfo = /** @class */ (function () {
- function SearchBotDeviceInfo(name, version, os, bot) {
- this.name = name;
- this.version = version;
- this.os = os;
- this.bot = bot;
- this.type = 'bot-device';
- }
- return SearchBotDeviceInfo;
- }());
- var BotInfo = /** @class */ (function () {
- function BotInfo() {
- this.type = 'bot';
- this.bot = true; // NOTE: deprecated test name instead
- this.name = 'bot';
- this.version = null;
- this.os = null;
- }
- return BotInfo;
- }());
- var ReactNativeInfo = /** @class */ (function () {
- function ReactNativeInfo() {
- this.type = 'react-native';
- this.name = 'react-native';
- this.version = null;
- this.os = null;
- }
- return ReactNativeInfo;
- }());
- // tslint:disable-next-line:max-line-length
- var SEARCHBOX_UA_REGEX = /alexa|bot|crawl(er|ing)|facebookexternalhit|feedburner|google web preview|nagios|postrank|pingdom|slurp|spider|yahoo!|yandex/;
- var SEARCHBOT_OS_REGEX = /(nuhk|curl|Googlebot|Yammybot|Openbot|Slurp|MSNBot|Ask\ Jeeves\/Teoma|ia_archiver)/;
- var REQUIRED_VERSION_PARTS = 3;
- var userAgentRules = [
- ['aol', /AOLShield\/([0-9\._]+)/],
- ['edge', /Edge\/([0-9\._]+)/],
- ['edge-ios', /EdgiOS\/([0-9\._]+)/],
- ['yandexbrowser', /YaBrowser\/([0-9\._]+)/],
- ['kakaotalk', /KAKAOTALK\s([0-9\.]+)/],
- ['samsung', /SamsungBrowser\/([0-9\.]+)/],
- ['silk', /\bSilk\/([0-9._-]+)\b/],
- ['miui', /MiuiBrowser\/([0-9\.]+)$/],
- ['beaker', /BeakerBrowser\/([0-9\.]+)/],
- ['edge-chromium', /EdgA?\/([0-9\.]+)/],
- [
- 'chromium-webview',
- /(?!Chrom.*OPR)wv\).*Chrom(?:e|ium)\/([0-9\.]+)(:?\s|$)/,
- ],
- ['chrome', /(?!Chrom.*OPR)Chrom(?:e|ium)\/([0-9\.]+)(:?\s|$)/],
- ['phantomjs', /PhantomJS\/([0-9\.]+)(:?\s|$)/],
- ['crios', /CriOS\/([0-9\.]+)(:?\s|$)/],
- ['firefox', /Firefox\/([0-9\.]+)(?:\s|$)/],
- ['fxios', /FxiOS\/([0-9\.]+)/],
- ['opera-mini', /Opera Mini.*Version\/([0-9\.]+)/],
- ['opera', /Opera\/([0-9\.]+)(?:\s|$)/],
- ['opera', /OPR\/([0-9\.]+)(:?\s|$)/],
- ['pie', /^Microsoft Pocket Internet Explorer\/(\d+\.\d+)$/],
- ['pie', /^Mozilla\/\d\.\d+\s\(compatible;\s(?:MSP?IE|MSInternet Explorer) (\d+\.\d+);.*Windows CE.*\)$/],
- ['netfront', /^Mozilla\/\d\.\d+.*NetFront\/(\d.\d)/],
- ['ie', /Trident\/7\.0.*rv\:([0-9\.]+).*\).*Gecko$/],
- ['ie', /MSIE\s([0-9\.]+);.*Trident\/[4-7].0/],
- ['ie', /MSIE\s(7\.0)/],
- ['bb10', /BB10;\sTouch.*Version\/([0-9\.]+)/],
- ['android', /Android\s([0-9\.]+)/],
- ['ios', /Version\/([0-9\._]+).*Mobile.*Safari.*/],
- ['safari', /Version\/([0-9\._]+).*Safari/],
- ['facebook', /FB[AS]V\/([0-9\.]+)/],
- ['instagram', /Instagram\s([0-9\.]+)/],
- ['ios-webview', /AppleWebKit\/([0-9\.]+).*Mobile/],
- ['ios-webview', /AppleWebKit\/([0-9\.]+).*Gecko\)$/],
- ['curl', /^curl\/([0-9\.]+)$/],
- ['searchbot', SEARCHBOX_UA_REGEX],
- ];
- var operatingSystemRules = [
- ['iOS', /iP(hone|od|ad)/],
- ['Android OS', /Android/],
- ['BlackBerry OS', /BlackBerry|BB10/],
- ['Windows Mobile', /IEMobile/],
- ['Amazon OS', /Kindle/],
- ['Windows 3.11', /Win16/],
- ['Windows 95', /(Windows 95)|(Win95)|(Windows_95)/],
- ['Windows 98', /(Windows 98)|(Win98)/],
- ['Windows 2000', /(Windows NT 5.0)|(Windows 2000)/],
- ['Windows XP', /(Windows NT 5.1)|(Windows XP)/],
- ['Windows Server 2003', /(Windows NT 5.2)/],
- ['Windows Vista', /(Windows NT 6.0)/],
- ['Windows 7', /(Windows NT 6.1)/],
- ['Windows 8', /(Windows NT 6.2)/],
- ['Windows 8.1', /(Windows NT 6.3)/],
- ['Windows 10', /(Windows NT 10.0)/],
- ['Windows ME', /Windows ME/],
- ['Windows CE', /Windows CE|WinCE|Microsoft Pocket Internet Explorer/],
- ['Open BSD', /OpenBSD/],
- ['Sun OS', /SunOS/],
- ['Chrome OS', /CrOS/],
- ['Linux', /(Linux)|(X11)/],
- ['Mac OS', /(Mac_PowerPC)|(Macintosh)/],
- ['QNX', /QNX/],
- ['BeOS', /BeOS/],
- ['OS/2', /OS\/2/],
- ];
- function detect(userAgent) {
- if (!!userAgent) {
- return parseUserAgent(userAgent);
- }
- if (typeof document === 'undefined' &&
- typeof navigator !== 'undefined' &&
- navigator.product === 'ReactNative') {
- return new ReactNativeInfo();
- }
- if (typeof navigator !== 'undefined') {
- return parseUserAgent(navigator.userAgent);
- }
- return getNodeVersion();
- }
- function matchUserAgent(ua) {
- // opted for using reduce here rather than Array#first with a regex.test call
- // this is primarily because using the reduce we only perform the regex
- // execution once rather than once for the test and for the exec again below
- // probably something that needs to be benchmarked though
- return (ua !== '' &&
- userAgentRules.reduce(function (matched, _a) {
- var browser = _a[0], regex = _a[1];
- if (matched) {
- return matched;
- }
- var uaMatch = regex.exec(ua);
- return !!uaMatch && [browser, uaMatch];
- }, false));
- }
- function parseUserAgent(ua) {
- var matchedRule = matchUserAgent(ua);
- if (!matchedRule) {
- return null;
- }
- var name = matchedRule[0], match = matchedRule[1];
- if (name === 'searchbot') {
- return new BotInfo();
- }
- // Do not use RegExp for split operation as some browser do not support it (See: http://blog.stevenlevithan.com/archives/cross-browser-split)
- var versionParts = match[1] && match[1].split('.').join('_').split('_').slice(0, 3);
- if (versionParts) {
- if (versionParts.length < REQUIRED_VERSION_PARTS) {
- versionParts = __spreadArray(__spreadArray([], versionParts, true), createVersionParts(REQUIRED_VERSION_PARTS - versionParts.length), true);
- }
- }
- else {
- versionParts = [];
- }
- var version = versionParts.join('.');
- var os = detectOS(ua);
- var searchBotMatch = SEARCHBOT_OS_REGEX.exec(ua);
- if (searchBotMatch && searchBotMatch[1]) {
- return new SearchBotDeviceInfo(name, version, os, searchBotMatch[1]);
- }
- return new BrowserInfo(name, version, os);
- }
- function detectOS(ua) {
- for (var ii = 0, count = operatingSystemRules.length; ii < count; ii++) {
- var _a = operatingSystemRules[ii], os = _a[0], regex = _a[1];
- var match = regex.exec(ua);
- if (match) {
- return os;
- }
- }
- return null;
- }
- function getNodeVersion() {
- var isNode = typeof process !== 'undefined' && process.version;
- return isNode ? new NodeInfo(process.version.slice(1)) : null;
- }
- function createVersionParts(count) {
- var output = [];
- for (var ii = 0; ii < count; ii++) {
- output.push('0');
- }
- return output;
- }
-
- /*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
- var browserInfo = detect();
- var logs$1;
- var config$1;
-
- // Interval Logging Globals
- var intervalID;
- var intervalType;
- var intervalPath;
- var intervalTimer;
- var intervalCounter;
- var intervalLog;
- var cbHandlers = {};
-
- /**
- * Adds named callbacks to be executed when logging.
- * @param {Object } newCallbacks An object containing named callback functions.
- */
- function addCallbacks() {
- for (var _len = arguments.length, newCallbacks = new Array(_len), _key = 0; _key < _len; _key++) {
- newCallbacks[_key] = arguments[_key];
- }
- newCallbacks.forEach(function (source) {
- var descriptors = Object.keys(source).reduce(function (descriptors, key) {
- descriptors[key] = Object.getOwnPropertyDescriptor(source, key);
- return descriptors;
- }, {});
- Object.getOwnPropertySymbols(source).forEach(function (sym) {
- var descriptor = Object.getOwnPropertyDescriptor(source, sym);
- if (descriptor.enumerable) {
- descriptors[sym] = descriptor;
- }
- });
- Object.defineProperties(cbHandlers, descriptors);
- });
- return cbHandlers;
- }
-
- /**
- * Removes callbacks by name.
- * @param {String[]} targetKeys A list of names of functions to remove.
- */
- function removeCallbacks(targetKeys) {
- targetKeys.forEach(function (key) {
- if (Object.hasOwn(cbHandlers, key)) {
- delete cbHandlers[key];
- }
- });
- }
-
- /**
- * Assigns the config and log container to be used by the logging functions.
- * @param {Array} newLogs Log container.
- * @param {Object} newConfig Configuration to use while logging.
- */
- function initPackager(newLogs, newConfig) {
- logs$1 = newLogs;
- config$1 = newConfig;
- cbHandlers = [];
- intervalID = null;
- intervalType = null;
- intervalPath = null;
- intervalTimer = null;
- intervalCounter = 0;
- intervalLog = null;
- }
-
- /**
- * Transforms the provided HTML event into a log and appends it to the log queue.
- * @param {Object} e The event to be logged.
- * @param {Function} detailFcn The function to extract additional log parameters from the event.
- * @return {boolean} Whether the event was logged.
- */
- function packageLog(e, detailFcn) {
- if (!config$1.on) {
- return false;
- }
- var details = null;
- if (detailFcn) {
- details = detailFcn(e);
- }
- var timeFields = extractTimeFields(e.timeStamp && e.timeStamp > 0 ? config$1.time(e.timeStamp) : Date.now());
- var log = {
- 'target': getSelector(e.target),
- 'path': buildPath(e),
- 'pageUrl': window.location.href,
- 'pageTitle': document.title,
- 'pageReferrer': document.referrer,
- 'browser': detectBrowser(),
- 'clientTime': timeFields.milli,
- 'microTime': timeFields.micro,
- 'location': getLocation(e),
- 'scrnRes': getSreenRes(),
- 'type': e.type,
- 'logType': 'raw',
- 'userAction': true,
- 'details': details,
- 'userId': config$1.userId,
- 'toolVersion': config$1.version,
- 'toolName': config$1.toolName,
- 'useraleVersion': config$1.useraleVersion,
- 'sessionID': config$1.sessionID
- };
- for (var _i = 0, _Object$values = Object.values(cbHandlers); _i < _Object$values.length; _i++) {
- var func = _Object$values[_i];
- if (typeof func === 'function') {
- log = func(log, e);
- if (!log) {
- return false;
- }
- }
- }
- logs$1.push(log);
- return true;
- }
-
- /**
- * Packages the provided customLog to include standard meta data and appends it to the log queue.
- * @param {Object} customLog The behavior to be logged.
- * @param {Function} detailFcn The function to extract additional log parameters from the event.
- * @param {boolean} userAction Indicates user behavior (true) or system behavior (false)
- * @return {boolean} Whether the event was logged.
- */
- function packageCustomLog(customLog, detailFcn, userAction) {
- if (!config$1.on) {
- return false;
- }
- var details = null;
- if (detailFcn) {
- details = detailFcn();
- }
- var metaData = {
- 'pageUrl': window.location.href,
- 'pageTitle': document.title,
- 'pageReferrer': document.referrer,
- 'browser': detectBrowser(),
- 'clientTime': Date.now(),
- 'scrnRes': getSreenRes(),
- 'logType': 'custom',
- 'userAction': userAction,
- 'details': details,
- 'userId': config$1.userId,
- 'toolVersion': config$1.version,
- 'toolName': config$1.toolName,
- 'useraleVersion': config$1.useraleVersion,
- 'sessionID': config$1.sessionID
- };
- var log = Object.assign(metaData, customLog);
- for (var _i2 = 0, _Object$values2 = Object.values(cbHandlers); _i2 < _Object$values2.length; _i2++) {
- var func = _Object$values2[_i2];
- if (typeof func === 'function') {
- log = func(log, null);
- if (!log) {
- return false;
- }
- }
- }
- logs$1.push(log);
- return true;
- }
-
- /**
- * Extract the millisecond and microsecond portions of a timestamp.
- * @param {Number} timeStamp The timestamp to split into millisecond and microsecond fields.
- * @return {Object} An object containing the millisecond
- * and microsecond portions of the timestamp.
- */
- function extractTimeFields(timeStamp) {
- return {
- milli: Math.floor(timeStamp),
- micro: Number((timeStamp % 1).toFixed(3))
- };
- }
-
- /**
- * Track intervals and gather details about it.
- * @param {Object} e
- * @return boolean
- */
- function packageIntervalLog(e) {
- var target = getSelector(e.target);
- var path = buildPath(e);
- var type = e.type;
- var timestamp = Math.floor(e.timeStamp && e.timeStamp > 0 ? config$1.time(e.timeStamp) : Date.now());
-
- // Init - this should only happen once on initialization
- if (intervalID == null) {
- intervalID = target;
- intervalType = type;
- intervalPath = path;
- intervalTimer = timestamp;
- intervalCounter = 0;
- }
- if (intervalID !== target || intervalType !== type) {
- // When to create log? On transition end
- // @todo Possible for intervalLog to not be pushed in the event the interval never ends...
-
- intervalLog = {
- 'target': intervalID,
- 'path': intervalPath,
- 'pageUrl': window.location.href,
- 'pageTitle': document.title,
- 'pageReferrer': document.referrer,
- 'browser': detectBrowser(),
- 'count': intervalCounter,
- 'duration': timestamp - intervalTimer,
- // microseconds
- 'startTime': intervalTimer,
- 'endTime': timestamp,
- 'type': intervalType,
- 'logType': 'interval',
- 'targetChange': intervalID !== target,
- 'typeChange': intervalType !== type,
- 'userAction': false,
- 'userId': config$1.userId,
- 'toolVersion': config$1.version,
- 'toolName': config$1.toolName,
- 'useraleVersion': config$1.useraleVersion,
- 'sessionID': config$1.sessionID
- };
- for (var _i3 = 0, _Object$values3 = Object.values(cbHandlers); _i3 < _Object$values3.length; _i3++) {
- var func = _Object$values3[_i3];
- if (typeof func === 'function') {
- intervalLog = func(intervalLog, null);
- if (!intervalLog) {
- return false;
- }
- }
- }
- logs$1.push(intervalLog);
-
- // Reset
- intervalID = target;
- intervalType = type;
- intervalPath = path;
- intervalTimer = timestamp;
- intervalCounter = 0;
- }
-
- // Interval is still occuring, just update counter
- if (intervalID == target && intervalType == type) {
- intervalCounter = intervalCounter + 1;
- }
- return true;
- }
-
- /**
- * Extracts coordinate information from the event
- * depending on a few browser quirks.
- * @param {Object} e The event to extract coordinate information from.
- * @return {Object} An object containing nullable x and y coordinates for the event.
- */
- function getLocation(e) {
- if (e.pageX != null) {
- return {
- 'x': e.pageX,
- 'y': e.pageY
- };
- } else if (e.clientX != null) {
- return {
- 'x': document.documentElement.scrollLeft + e.clientX,
- 'y': document.documentElement.scrollTop + e.clientY
- };
- } else {
- return {
- 'x': null,
- 'y': null
- };
- }
- }
-
- /**
- * Extracts innerWidth and innerHeight to provide estimates of screen resolution
- * @return {Object} An object containing the innerWidth and InnerHeight
- */
- function getSreenRes() {
- return {
- 'width': window.innerWidth,
- 'height': window.innerHeight
- };
- }
-
- /**
- * Builds a string CSS selector from the provided element
- * @param {HTMLElement} ele The element from which the selector is built.
- * @return {string} The CSS selector for the element, or Unknown if it can't be determined.
- */
- function getSelector(ele) {
- if (ele.localName) {
- return ele.localName + (ele.id ? '#' + ele.id : '') + (ele.className ? '.' + ele.className : '');
- } else if (ele.nodeName) {
- return ele.nodeName + (ele.id ? '#' + ele.id : '') + (ele.className ? '.' + ele.className : '');
- } else if (ele && ele.document && ele.location && ele.alert && ele.setInterval) {
- return "Window";
- } else {
- return "Unknown";
- }
- }
-
- /**
- * Builds an array of elements from the provided event target, to the root element.
- * @param {Object} e Event from which the path should be built.
- * @return {HTMLElement[]} Array of elements, starting at the event target, ending at the root element.
- */
- function buildPath(e) {
- if (e instanceof window.Event) {
- var path = e.composedPath();
- return selectorizePath(path);
- }
- }
-
- /**
- * Builds a CSS selector path from the provided list of elements.
- * @param {HTMLElement[]} path Array of HTMLElements from which the path should be built.
- * @return {string[]} Array of string CSS selectors.
- */
- function selectorizePath(path) {
- var i = 0;
- var pathEle;
- var pathSelectors = [];
- while (pathEle = path[i]) {
- pathSelectors.push(getSelector(pathEle));
- ++i;
- }
- return pathSelectors;
- }
- function detectBrowser() {
- return {
- 'browser': browserInfo ? browserInfo.name : '',
- 'version': browserInfo ? browserInfo.version : ''
- };
- }
-
- /*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
- var events;
- var bufferBools;
- var bufferedEvents;
- //@todo: Investigate drag events and their behavior
- var intervalEvents = ['click', 'focus', 'blur', 'input', 'change', 'mouseover', 'submit'];
- var refreshEvents;
- var windowEvents = ['load', 'blur', 'focus'];
-
- /**
- * Maps an event to an object containing useful information.
- * @param {Object} e Event to extract data from
- */
- function extractMouseEvent(e) {
- return {
- 'clicks': e.detail,
- 'ctrl': e.ctrlKey,
- 'alt': e.altKey,
- 'shift': e.shiftKey,
- 'meta': e.metaKey
- // 'text' : e.target.innerHTML
- };
- }
-
- /**
- * Defines the way information is extracted from various events.
- * Also defines which events we will listen to.
- * @param {Object} config Configuration object to read from.
- */
- function defineDetails(config) {
- // Events list
- // Keys are event types
- // Values are functions that return details object if applicable
- events = {
- 'click': extractMouseEvent,
- 'dblclick': extractMouseEvent,
- 'mousedown': extractMouseEvent,
- 'mouseup': extractMouseEvent,
- 'focus': null,
- 'blur': null,
- 'input': config.logDetails ? function (e) {
- return {
- 'value': e.target.value
- };
- } : null,
- 'change': config.logDetails ? function (e) {
- return {
- 'value': e.target.value
- };
- } : null,
- 'dragstart': null,
- 'dragend': null,
- 'drag': null,
- 'drop': null,
- 'keydown': config.logDetails ? function (e) {
- return {
- 'key': e.keyCode,
- 'ctrl': e.ctrlKey,
- 'alt': e.altKey,
- 'shift': e.shiftKey,
- 'meta': e.metaKey
- };
- } : null,
- 'mouseover': null
- };
- bufferBools = {};
- bufferedEvents = {
- 'wheel': function wheel(e) {
- return {
- 'x': e.deltaX,
- 'y': e.deltaY,
- 'z': e.deltaZ
- };
- },
- 'scroll': function scroll() {
- return {
- 'x': window.scrollX,
- 'y': window.scrollY
- };
- },
- 'resize': function resize() {
- return {
- 'width': window.outerWidth,
- 'height': window.outerHeight
- };
- }
- };
- refreshEvents = {
- 'submit': null
- };
- }
-
- /**
- * Defines the way information is extracted from various events.
- * Also defines which events we will listen to.
- * @param {Object} options UserALE.js Configuration object to read from.
- * @param {string} type of html event (e.g., 'click', 'mouseover', etc.), such as passed to addEventListener methods.
- */
- function defineCustomDetails(options, type) {
- // Events list
- // Keys are event types
- // Values are functions that return details object if applicable
- var eventType = {
- 'click': extractMouseEvent,
- 'dblclick': extractMouseEvent,
- 'mousedown': extractMouseEvent,
- 'mouseup': extractMouseEvent,
- 'focus': null,
- 'blur': null,
- 'input': options.logDetails ? function (e) {
- return {
- 'value': e.target.value
- };
- } : null,
- 'change': options.logDetails ? function (e) {
- return {
- 'value': e.target.value
- };
- } : null,
- 'dragstart': null,
- 'dragend': null,
- 'drag': null,
- 'drop': null,
- 'keydown': options.logDetails ? function (e) {
- return {
- 'key': e.keyCode,
- 'ctrl': e.ctrlKey,
- 'alt': e.altKey,
- 'shift': e.shiftKey,
- 'meta': e.metaKey
- };
- } : null,
- 'mouseover': null,
- 'wheel': function wheel(e) {
- return {
- 'x': e.deltaX,
- 'y': e.deltaY,
- 'z': e.deltaZ
- };
- },
- 'scroll': function scroll() {
- return {
- 'x': window.scrollX,
- 'y': window.scrollY
- };
- },
- 'resize': function resize() {
- return {
- 'width': window.outerWidth,
- 'height': window.outerHeight
- };
- },
- 'submit': null
- };
- return eventType[type];
- }
-
- /**
- * Hooks the event handlers for each event type of interest.
- * @param {Object} config Configuration object to use.
- * @return {boolean} Whether the operation succeeded
- */
- function attachHandlers(config) {
- defineDetails(config);
- Object.keys(events).forEach(function (ev) {
- document.addEventListener(ev, function (e) {
- packageLog(e, events[ev]);
- }, true);
- });
- intervalEvents.forEach(function (ev) {
- document.addEventListener(ev, function (e) {
- packageIntervalLog(e);
- }, true);
- });
- Object.keys(bufferedEvents).forEach(function (ev) {
- bufferBools[ev] = true;
- window.addEventListener(ev, function (e) {
- if (bufferBools[ev]) {
- bufferBools[ev] = false;
- packageLog(e, bufferedEvents[ev]);
- setTimeout(function () {
- bufferBools[ev] = true;
- }, config.resolution);
- }
- }, true);
- });
- Object.keys(refreshEvents).forEach(function (ev) {
- document.addEventListener(ev, function (e) {
- packageLog(e, events[ev]);
- }, true);
- });
- windowEvents.forEach(function (ev) {
- window.addEventListener(ev, function (e) {
- packageLog(e, function () {
- return {
- 'window': true
- };
- });
- }, true);
- });
- return true;
- }
-
- function _arrayWithHoles(arr) {
- if (Array.isArray(arr)) return arr;
- }
-
- function _iterableToArrayLimit(r, l) {
- var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"];
- if (null != t) {
- var e,
- n,
- i,
- u,
- a = [],
- f = !0,
- o = !1;
- try {
- if (i = (t = t.call(r)).next, 0 === l) {
- if (Object(t) !== t) return;
- f = !1;
- } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0);
- } catch (r) {
- o = !0, n = r;
- } finally {
- try {
- if (!f && null != t["return"] && (u = t["return"](), Object(u) !== u)) return;
- } finally {
- if (o) throw n;
- }
- }
- return a;
- }
- }
-
- function _arrayLikeToArray(arr, len) {
- if (len == null || len > arr.length) len = arr.length;
- for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i];
- return arr2;
- }
-
- function _unsupportedIterableToArray(o, minLen) {
- if (!o) return;
- if (typeof o === "string") return _arrayLikeToArray(o, minLen);
- var n = Object.prototype.toString.call(o).slice(8, -1);
- if (n === "Object" && o.constructor) n = o.constructor.name;
- if (n === "Map" || n === "Set") return Array.from(o);
- if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen);
- }
-
- function _nonIterableRest() {
- throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
- }
-
- function _slicedToArray(arr, i) {
- return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest();
- }
-
- /*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
- var authCallback = null;
-
- /**
- * Fetches the most up-to-date auth header string from the auth callback
- * and updates the config object with the new value.
- * @param {Object} config Configuration object to be updated.
- * @param {Function} authCallback Callback used to fetch the newest header.
- * @returns {void}
- */
- function updateAuthHeader(config) {
- if (authCallback) {
- try {
- config.authHeader = authCallback();
- } catch (e) {
- // We should emit the error, but otherwise continue as this could be a temporary issue
- // due to network connectivity or some logic inside the authCallback which is the user's
- // responsibility.
- console.error("Error encountered while setting the auth header: ".concat(e));
- }
- }
- }
-
- /**
- * Registers the provided callback to be used when updating the auth header.
- * @param {Function} callback Callback used to fetch the newest header. Should return a string.
- * @returns {boolean} Whether the operation succeeded.
- */
- function registerAuthCallback(callback) {
- try {
- verifyCallback(callback);
- authCallback = callback;
- return true;
- } catch (e) {
- return false;
- }
- }
-
- /**
- * Verify that the provided callback is a function which returns a string
- * @param {Function} callback Callback used to fetch the newest header. Should return a string.
- * @throws {Error} If the callback is not a function or does not return a string.
- * @returns {void}
- */
- function verifyCallback(callback) {
- if (typeof callback !== "function") {
- throw new Error("Userale auth callback must be a function");
- }
- var result = callback();
- if (typeof result !== "string") {
- throw new Error("Userale auth callback must return a string");
- }
- }
-
- var sendIntervalId = null;
-
- /**
- * Initializes the log queue processors.
- * @param {Array} logs Array of logs to append to.
- * @param {Object} config Configuration object to use when logging.
- */
- function initSender(logs, config) {
- if (sendIntervalId !== null) {
- clearInterval(sendIntervalId);
- }
- sendIntervalId = sendOnInterval(logs, config);
- sendOnClose(logs, config);
- }
-
- /**
- * Checks the provided log array on an interval, flushing the logs
- * if the queue has reached the threshold specified by the provided config.
- * @param {Array} logs Array of logs to read from.
- * @param {Object} config Configuration object to be read from.
- * @return {Number} The newly created interval id.
- */
- function sendOnInterval(logs, config) {
- return setInterval(function () {
- if (!config.on) {
- return;
- }
- if (logs.length >= config.logCountThreshold) {
- sendLogs(logs.slice(0), config, 0); // Send a copy
- logs.splice(0); // Clear array reference (no reassignment)
- }
- }, config.transmitInterval);
- }
-
- /**
- * Attempts to flush the remaining logs when the window is closed.
- * @param {Array} logs Array of logs to be flushed.
- * @param {Object} config Configuration object to be read from.
- */
- function sendOnClose(logs, config) {
- window.addEventListener("pagehide", function () {
- if (config.on && logs.length > 0) {
- // NOTE: sendBeacon does not support auth headers,
- // so this will fail if auth is required.
- // The alternative is to use fetch() with keepalive: true
- // https://developer.mozilla.org/en-US/docs/Web/API/Navigator/sendBeacon#description
- // https://stackoverflow.com/a/73062712/9263449
- navigator.sendBeacon(config.url, JSON.stringify(logs));
- logs.splice(0); // clear log queue
- }
- });
- }
-
- /**
- * Sends the provided array of logs to the specified url,
- * retrying the request up to the specified number of retries.
- * @param {Array} logs Array of logs to send.
- * @param {string} config configuration parameters (e.g., to extract URL from & send the POST request to).
- * @param {Number} retries Maximum number of attempts to send the logs.
- */
-
- // @todo expose config object to sendLogs replate url with config.url
- function sendLogs(logs, config, retries) {
- var req = new XMLHttpRequest();
- var data = JSON.stringify(logs);
- req.open("POST", config.url);
-
- // Update headers
- updateAuthHeader(config);
- if (config.authHeader) {
- req.setRequestHeader("Authorization", config.authHeader);
- }
- req.setRequestHeader("Content-type", "application/json;charset=UTF-8");
- if (config.headers) {
- Object.entries(config.headers).forEach(function (_ref) {
- var _ref2 = _slicedToArray(_ref, 2),
- header = _ref2[0],
- value = _ref2[1];
- req.setRequestHeader(header, value);
- });
- }
- req.onreadystatechange = function () {
- if (req.readyState === 4 && req.status !== 200) {
- if (retries > 0) {
- sendLogs(logs, config, retries--);
- }
- }
- };
- req.send(data);
- }
-
- var config = {};
- var logs = [];
- var startLoadTimestamp = Date.now();
- var endLoadTimestamp;
- window.onload = function () {
- endLoadTimestamp = Date.now();
- };
- exports.started = false;
-
- // Start up Userale
- config.on = false;
- config.useraleVersion = version$1;
- configure(config, getInitialSettings());
- initPackager(logs, config);
- if (config.autostart) {
- setup(config);
- }
-
- /**
- * Hooks the global event listener, and starts up the
- * logging interval.
- * @param {Object} config Configuration settings for the logger
- */
- function setup(config) {
- if (!exports.started) {
- setTimeout(function () {
- var state = document.readyState;
- if (config.autostart && (state === 'interactive' || state === 'complete')) {
- attachHandlers(config);
- initSender(logs, config);
- exports.started = config.on = true;
- packageCustomLog({
- type: 'load',
- details: {
- pageLoadTime: endLoadTimestamp - startLoadTimestamp
- }
- }, function () {}, false);
- } else {
- setup(config);
- }
- }, 100);
- }
- }
-
- // Export the Userale API
- var version = version$1;
-
- /**
- * Used to start the logging process if the
- * autostart configuration option is set to false.
- */
- function start() {
- if (!exports.started || config.autostart === false) {
- exports.started = config.on = true;
- config.autostart = true;
- }
- }
-
- /**
- * Halts the logging process. Logs will no longer be sent.
- */
- function stop() {
- exports.started = config.on = false;
- config.autostart = false;
- }
-
- /**
- * Updates the current configuration
- * object with the provided values.
- * @param {Object} newConfig The configuration options to use.
- * @return {Object} Returns the updated configuration.
- */
- function options(newConfig) {
- if (newConfig !== undefined) {
- configure(config, newConfig);
- }
- return config;
- }
-
- /**
- * Appends a log to the log queue.
- * @param {Object} customLog The log to append.
- * @return {boolean} Whether the operation succeeded.
- */
- function log(customLog) {
- if (customLog !== null && _typeof(customLog) === 'object') {
- logs.push(customLog);
- return true;
- } else {
- return false;
- }
- }
-
- exports.addCallbacks = addCallbacks;
- exports.buildPath = buildPath;
- exports.details = defineCustomDetails;
- exports.getSelector = getSelector;
- exports.log = log;
- exports.options = options;
- exports.packageCustomLog = packageCustomLog;
- exports.packageLog = packageLog;
- exports.registerAuthCallback = registerAuthCallback;
- exports.removeCallbacks = removeCallbacks;
- exports.start = start;
- exports.stop = stop;
- exports.version = version;
-
-}));
diff --git a/build/userale-2.4.0.min.js b/build/userale-2.4.0.min.js
deleted file mode 100644
index e87a122..0000000
--- a/build/userale-2.4.0.min.js
+++ /dev/null
@@ -1,18 +0,0 @@
-/**
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * @preserved
- */
-!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports):"function"==typeof define&&define.amd?define(["exports"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self).userale={})}(this,(function(e){"use strict";function t(e){return t="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},t(e)}var n="2.4.0",r=null;function o(e,t){var n=e.autostart,r=t.autostart;Object.keys(t).forEach((function(n){if("userFromParams"===n){var r=(o=t[n],i=new RegExp("[?&]"+o+"(=([^&#]*)|&|#|$)"),(a=window.location.href.match(i))&&a[2]?decodeURIComponent(a[2].replace(/\+/g," ")):null);r&&(e.userId=r)}var o,i,a;e[n]=t[n]})),!1!==n&&!1!==r||(e.autostart=!1)}var i=function(e,t,n){if(n||2===arguments.length)for(var r,o=0,i=t.length;o<i;o++)!r&&o in t||(r||(r=Array.prototype.slice.call(t,0,o)),r[o]=t[o]);return e.concat(r||Array.prototype.slice.call(t))},a=function(e,t,n){this.name=e,this.version=t,this.os=n,this.type="browser"},l=function(e){this.version=e,this.type="node",this.name="node",this.os=process.platform},u=function(e,t,n,r){this.name=e,this.version=t,this.os=n,this.bot=r,this.type="bot-device"},s=function(){this.type="bot",this.bot=!0,this.name="bot",this.version=null,this.os=null},c=function(){this.type="react-native",this.name="react-native",this.version=null,this.os=null},d=/(nuhk|curl|Googlebot|Yammybot|Openbot|Slurp|MSNBot|Ask\ Jeeves\/Teoma|ia_archiver)/,f=3,m=[["aol",/AOLShield\/([0-9\._]+)/],["edge",/Edge\/([0-9\._]+)/],["edge-ios",/EdgiOS\/([0-9\._]+)/],["yandexbrowser",/YaBrowser\/([0-9\._]+)/],["kakaotalk",/KAKAOTALK\s([0-9\.]+)/],["samsung",/SamsungBrowser\/([0-9\.]+)/],["silk",/\bSilk\/([0-9._-]+)\b/],["miui",/MiuiBrowser\/([0-9\.]+)$/],["beaker",/BeakerBrowser\/([0-9\.]+)/],["edge-chromium",/EdgA?\/([0-9\.]+)/],["chromium-webview",/(?!Chrom.*OPR)wv\).*Chrom(?:e|ium)\/([0-9\.]+)(:?\s|$)/],["chrome",/(?!Chrom.*OPR)Chrom(?:e|ium)\/([0-9\.]+)(:?\s|$)/],["phantomjs",/PhantomJS\/([0-9\.]+)(:?\s|$)/],["crios",/CriOS\/([0-9\.]+)(:?\s|$)/],["firefox",/Firefox\/([0-9\.]+)(?:\s|$)/],["fxios",/FxiOS\/([0-9\.]+)/],["opera-mini",/Opera Mini.*Version\/([0-9\.]+)/],["opera",/Opera\/([0-9\.]+)(?:\s|$)/],["opera",/OPR\/([0-9\.]+)(:?\s|$)/],["pie",/^Microsoft Pocket Internet Explorer\/(\d+\.\d+)$/],["pie",/^Mozilla\/\d\.\d+\s\(compatible;\s(?:MSP?IE|MSInternet Explorer) (\d+\.\d+);.*Windows CE.*\)$/],["netfront",/^Mozilla\/\d\.\d+.*NetFront\/(\d.\d)/],["ie",/Trident\/7\.0.*rv\:([0-9\.]+).*\).*Gecko$/],["ie",/MSIE\s([0-9\.]+);.*Trident\/[4-7].0/],["ie",/MSIE\s(7\.0)/],["bb10",/BB10;\sTouch.*Version\/([0-9\.]+)/],["android",/Android\s([0-9\.]+)/],["ios",/Version\/([0-9\._]+).*Mobile.*Safari.*/],["safari",/Version\/([0-9\._]+).*Safari/],["facebook",/FB[AS]V\/([0-9\.]+)/],["instagram",/Instagram\s([0-9\.]+)/],["ios-webview",/AppleWebKit\/([0-9\.]+).*Mobile/],["ios-webview",/AppleWebKit\/([0-9\.]+).*Gecko\)$/],["curl",/^curl\/([0-9\.]+)$/],["searchbot",/alexa|bot|crawl(er|ing)|facebookexternalhit|feedburner|google web preview|nagios|postrank|pingdom|slurp|spider|yahoo!|yandex/]],h=[["iOS",/iP(hone|od|ad)/],["Android OS",/Android/],["BlackBerry OS",/BlackBerry|BB10/],["Windows Mobile",/IEMobile/],["Amazon OS",/Kindle/],["Windows 3.11",/Win16/],["Windows 95",/(Windows 95)|(Win95)|(Windows_95)/],["Windows 98",/(Windows 98)|(Win98)/],["Windows 2000",/(Windows NT 5.0)|(Windows 2000)/],["Windows XP",/(Windows NT 5.1)|(Windows XP)/],["Windows Server 2003",/(Windows NT 5.2)/],["Windows Vista",/(Windows NT 6.0)/],["Windows 7",/(Windows NT 6.1)/],["Windows 8",/(Windows NT 6.2)/],["Windows 8.1",/(Windows NT 6.3)/],["Windows 10",/(Windows NT 10.0)/],["Windows ME",/Windows ME/],["Windows CE",/Windows CE|WinCE|Microsoft Pocket Internet Explorer/],["Open BSD",/OpenBSD/],["Sun OS",/SunOS/],["Chrome OS",/CrOS/],["Linux",/(Linux)|(X11)/],["Mac OS",/(Mac_PowerPC)|(Macintosh)/],["QNX",/QNX/],["BeOS",/BeOS/],["OS/2",/OS\/2/]];function p(e){var t=function(e){return""!==e&&m.reduce((function(t,n){var r=n[0],o=n[1];if(t)return t;var i=o.exec(e);return!!i&&[r,i]}),!1)}(e);if(!t)return null;var n=t[0],r=t[1];if("searchbot"===n)return new s;var o=r[1]&&r[1].split(".").join("_").split("_").slice(0,3);o?o.length<f&&(o=i(i([],o,!0),function(e){for(var t=[],n=0;n<e;n++)t.push("0");return t}(f-o.length),!0)):o=[];var l=o.join("."),c=function(e){for(var t=0,n=h.length;t<n;t++){var r=h[t],o=r[0];if(r[1].exec(e))return o}return null}(e),p=d.exec(e);return p&&p[1]?new u(n,l,c,p[1]):new a(n,l,c)}var w,g,v,y,b,S,O,k,E,W,I,T,N=w?p(w):"undefined"==typeof document&&"undefined"!=typeof navigator&&"ReactNative"===navigator.product?new c:"undefined"!=typeof navigator?p(navigator.userAgent):"undefined"!=typeof process&&process.version?new l(process.version.slice(1)):null,x={};function A(e,t){if(!v.on)return!1;var n=null;t&&(n=t(e));for(var r,o=(r=e.timeStamp&&e.timeStamp>0?v.time(e.timeStamp):Date.now(),{milli:Math.floor(r),micro:Number((r%1).toFixed(3))}),i={target:M(e.target),path:B(e),pageUrl:window.location.href,pageTitle:document.title,pageReferrer:document.referrer,browser:P(),clientTime:o.milli,microTime:o.micro,location:C(e),scrnRes:D(),type:e.type,logType:"raw",userAction:!0,details:n,userId:v.userId,toolVersion:v.version,toolName:v.toolName,useraleVersion:v.useraleVersion,sessionID:v.sessionID},a=0,l=Object.values(x);a<l.length;a++){var u=l[a];if("function"==typeof u&&!(i=u(i,e)))return!1}return g.push(i),!0}function j(e,t,n){if(!v.on)return!1;var r=null;t&&(r=t());for(var o={pageUrl:window.location.href,pageTitle:document.title,pageReferrer:document.referrer,browser:P(),clientTime:Date.now(),scrnRes:D(),logType:"custom",userAction:n,details:r,userId:v.userId,toolVersion:v.version,toolName:v.toolName,useraleVersion:v.useraleVersion,sessionID:v.sessionID},i=Object.assign(o,e),a=0,l=Object.values(x);a<l.length;a++){var u=l[a];if("function"==typeof u&&!(i=u(i,null)))return!1}return g.push(i),!0}function C(e){return null!=e.pageX?{x:e.pageX,y:e.pageY}:null!=e.clientX?{x:document.documentElement.scrollLeft+e.clientX,y:document.documentElement.scrollTop+e.clientY}:{x:null,y:null}}function D(){return{width:window.innerWidth,height:window.innerHeight}}function M(e){return e.localName?e.localName+(e.id?"#"+e.id:"")+(e.className?"."+e.className:""):e.nodeName?e.nodeName+(e.id?"#"+e.id:"")+(e.className?"."+e.className:""):e&&e.document&&e.location&&e.alert&&e.setInterval?"Window":"Unknown"}function B(e){if(e instanceof window.Event)return function(e){var t,n=0,r=[];for(;t=e[n];)r.push(M(t)),++n;return r}(e.composedPath())}function P(){return{browser:N?N.name:"",version:N?N.version:""}}var K,V=["click","focus","blur","input","change","mouseover","submit"],L=["load","blur","focus"];function R(e){return{clicks:e.detail,ctrl:e.ctrlKey,alt:e.altKey,shift:e.shiftKey,meta:e.metaKey}}function $(e){return function(e){W={click:R,dblclick:R,mousedown:R,mouseup:R,focus:null,blur:null,input:e.logDetails?function(e){return{value:e.target.value}}:null,change:e.logDetails?function(e){return{value:e.target.value}}:null,dragstart:null,dragend:null,drag:null,drop:null,keydown:e.logDetails?function(e){return{key:e.keyCode,ctrl:e.ctrlKey,alt:e.altKey,shift:e.shiftKey,meta:e.metaKey}}:null,mouseover:null},I={},T={wheel:function(e){return{x:e.deltaX,y:e.deltaY,z:e.deltaZ}},scroll:function(){return{x:window.scrollX,y:window.scrollY}},resize:function(){return{width:window.outerWidth,height:window.outerHeight}}},K={submit:null}}(e),Object.keys(W).forEach((function(e){document.addEventListener(e,(function(t){A(t,W[e])}),!0)})),V.forEach((function(e){document.addEventListener(e,(function(e){!function(e){var t=M(e.target),n=B(e),r=e.type,o=Math.floor(e.timeStamp&&e.timeStamp>0?v.time(e.timeStamp):Date.now());if(null==y&&(y=t,b=r,S=n,O=o,k=0),y!==t||b!==r){E={target:y,path:S,pageUrl:window.location.href,pageTitle:document.title,pageReferrer:document.referrer,browser:P(),count:k,duration:o-O,startTime:O,endTime:o,type:b,logType:"interval",targetChange:y!==t,typeChange:b!==r,userAction:!1,userId:v.userId,toolVersion:v.version,toolName:v.toolName,useraleVersion:v.useraleVersion,sessionID:v.sessionID};for(var i=0,a=Object.values(x);i<a.length;i++){var l=a[i];if("function"==typeof l&&!(E=l(E,null)))return!1}g.push(E),y=t,b=r,S=n,O=o,k=0}y==t&&b==r&&(k+=1)}(e)}),!0)})),Object.keys(T).forEach((function(t){I[t]=!0,window.addEventListener(t,(function(n){I[t]&&(I[t]=!1,A(n,T[t]),setTimeout((function(){I[t]=!0}),e.resolution))}),!0)})),Object.keys(K).forEach((function(e){document.addEventListener(e,(function(t){A(t,W[e])}),!0)})),L.forEach((function(e){window.addEventListener(e,(function(e){A(e,(function(){return{window:!0}}))}),!0)})),!0}function X(e,t){(null==t||t>e.length)&&(t=e.length);for(var n=0,r=new Array(t);n<t;n++)r[n]=e[n];return r}function _(e,t){return function(e){if(Array.isArray(e))return e}(e)||function(e,t){var n=null==e?null:"undefined"!=typeof Symbol&&e[Symbol.iterator]||e["@@iterator"];if(null!=n){var r,o,i,a,l=[],u=!0,s=!1;try{if(i=(n=n.call(e)).next,0===t){if(Object(n)!==n)return;u=!1}else for(;!(u=(r=i.call(n)).done)&&(l.push(r.value),l.length!==t);u=!0);}catch(e){s=!0,o=e}finally{try{if(!u&&null!=n.return&&(a=n.return(),Object(a)!==a))return}finally{if(s)throw o}}return l}}(e,t)||function(e,t){if(e){if("string"==typeof e)return X(e,t);var n=Object.prototype.toString.call(e).slice(8,-1);return"Object"===n&&e.constructor&&(n=e.constructor.name),"Map"===n||"Set"===n?Array.from(e):"Arguments"===n||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)?X(e,t):void 0}}(e,t)||function(){throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}()}var H=null;var U=null;function z(e,t){null!==U&&clearInterval(U),U=function(e,t){return setInterval((function(){t.on&&e.length>=t.logCountThreshold&&(F(e.slice(0),t,0),e.splice(0))}),t.transmitInterval)}(e,t),function(e,t){window.addEventListener("pagehide",(function(){t.on&&e.length>0&&(navigator.sendBeacon(t.url,JSON.stringify(e)),e.splice(0))}))}(e,t)}function F(e,t,n){var r=new XMLHttpRequest,o=JSON.stringify(e);r.open("POST",t.url),function(e){if(H)try{e.authHeader=H()}catch(e){console.error("Error encountered while setting the auth header: ".concat(e))}}(t),t.authHeader&&r.setRequestHeader("Authorization",t.authHeader),r.setRequestHeader("Content-type","application/json;charset=UTF-8"),t.headers&&Object.entries(t.headers).forEach((function(e){var t=_(e,2),n=t[0],o=t[1];r.setRequestHeader(n,o)})),r.onreadystatechange=function(){4===r.readyState&&200!==r.status&&n>0&&F(e,t,n--)},r.send(o)}var Y,J={},q=[],G=Date.now();window.onload=function(){Y=Date.now()},e.started=!1,J.on=!1,J.useraleVersion=n,o(J,function(){var e={};null===r&&(r=function(e,t){if(null===window.sessionStorage.getItem(e))return window.sessionStorage.setItem(e,JSON.stringify(t)),t;return JSON.parse(window.sessionStorage.getItem(e))}("userAleSessionId","session_"+String(Date.now())));var t,n=document.currentScript||(t=document.getElementsByTagName("script"))[t.length-1],o=n?n.getAttribute.bind(n):function(){return null};return e.autostart="false"!==o("data-autostart"),e.url=o("data-url")||"http://localhost:8000",e.transmitInterval=+o("data-interval")||5e3,e.logCountThreshold=+o("data-threshold")||5,e.userId=o("data-user")||null,e.version=o("data-version")||null,e.logDetails="true"===o("data-log-details"),e.resolution=+o("data-resolution")||500,e.toolName=o("data-tool")||null,e.userFromParams=o("data-user-from-params")||null,e.time=function(e){var t;if(e.timeStamp&&e.timeStamp>0){var n=Date.now()-e.timeStamp;if(n<0)t=function(){return e.timeStamp/1e3};else if(n>e.timeStamp){var r=performance.timing.navigationStart;t=function(e){return e+r}}else t=function(e){return e}}else t=function(){return Date.now()};return t}(document.createEvent("CustomEvent")),e.sessionID=o("data-session")||r,e.authHeader=o("data-auth")||null,e.custIndex=o("data-index")||null,e.headers=o("data-headers")||null,e}()),g=q,v=J,x=[],y=null,b=null,S=null,O=null,k=0,E=null,J.autostart&&function t(n){e.started||setTimeout((function(){var r=document.readyState;!n.autostart||"interactive"!==r&&"complete"!==r?t(n):($(n),z(q,n),e.started=n.on=!0,j({type:"load",details:{pageLoadTime:Y-G}},(function(){}),!1))}),100)}(J);var Q=n;e.addCallbacks=function(){for(var e=arguments.length,t=new Array(e),n=0;n<e;n++)t[n]=arguments[n];return t.forEach((function(e){var t=Object.keys(e).reduce((function(t,n){return t[n]=Object.getOwnPropertyDescriptor(e,n),t}),{});Object.getOwnPropertySymbols(e).forEach((function(n){var r=Object.getOwnPropertyDescriptor(e,n);r.enumerable&&(t[n]=r)})),Object.defineProperties(x,t)})),x},e.buildPath=B,e.details=function(e,t){return{click:R,dblclick:R,mousedown:R,mouseup:R,focus:null,blur:null,input:e.logDetails?function(e){return{value:e.target.value}}:null,change:e.logDetails?function(e){return{value:e.target.value}}:null,dragstart:null,dragend:null,drag:null,drop:null,keydown:e.logDetails?function(e){return{key:e.keyCode,ctrl:e.ctrlKey,alt:e.altKey,shift:e.shiftKey,meta:e.metaKey}}:null,mouseover:null,wheel:function(e){return{x:e.deltaX,y:e.deltaY,z:e.deltaZ}},scroll:function(){return{x:window.scrollX,y:window.scrollY}},resize:function(){return{width:window.outerWidth,height:window.outerHeight}},submit:null}[t]},e.getSelector=M,e.log=function(e){return null!==e&&"object"===t(e)&&(q.push(e),!0)},e.options=function(e){return void 0!==e&&o(J,e),J},e.packageCustomLog=j,e.packageLog=A,e.registerAuthCallback=function(e){try{return function(e){if("function"!=typeof e)throw new Error("Userale auth callback must be a function");var t=e();if("string"!=typeof t)throw new Error("Userale auth callback must return a string")}(e),H=e,!0}catch(e){return!1}},e.removeCallbacks=function(e){e.forEach((function(e){Object.hasOwn(x,e)&&delete x[e]}))},e.start=function(){e.started&&!1!==J.autostart||(e.started=J.on=!0,J.autostart=!0)},e.stop=function(){e.started=J.on=!1,J.autostart=!1},e.version=Q}));
diff --git a/package.json b/package.json
index dd84de1..251b6ae 100644
--- a/package.json
+++ b/package.json
@@ -8,7 +8,7 @@
"pretest": "npm run lint && npm run clean && npm run build",
"test": "mocha --require @babel/register && npm run journey:ci",
"build": "rollup -c --bundleConfigAsCjs rollup.config.js",
- "clean": "rm -r ./build",
+ "clean": "rm -rf ./build",
"journey": "cypress run",
"journey:debug": "cypress open",
"journey:ci": "start-server-and-test example:run 8000 journey",
diff --git a/src/UserALEWebExtension/background.js b/src/UserALEWebExtension/background.js
index 90160ad..19fecef 100644
--- a/src/UserALEWebExtension/background.js
+++ b/src/UserALEWebExtension/background.js
@@ -39,7 +39,14 @@
};
var urlWhitelist;
+var tabToHttpSession = {};
+var browserSessionId = null;
+/**
+ * Apply the extension config to both the background and content instances of userale
+ * @param {Object} config The extension config to apply
+ * @return {undefined}
+ */
function updateConfig(config) {
urlWhitelist = new RegExp(config.pluginConfig.urlWhitelist);
userale.options(config.useraleConfig);
@@ -47,6 +54,11 @@
dispatchTabMessage(config.useraleConfig);
}
+/**
+ * Send a message to all tabs
+ * @param {Object} message The message to send
+ * @return {undefined}
+ */
function dispatchTabMessage(message) {
browser.tabs.query({}, function (tabs) {
tabs.forEach(function (tab) {
@@ -55,7 +67,11 @@
});
}
-// Filter out logs with urls that do not match the regex defined in extension options.
+/**
+ * Callback for filtering out logs with urls that do not match the regex defined in extension options.
+ * @param {Object} log The candidate log
+ * @return {Object} The transformed log
+ */
function filterUrl(log) {
if(urlWhitelist.test(log.pageUrl)) {
return log
@@ -63,10 +79,27 @@
return false;
}
+/**
+ * Callback for setting the session id's of tab logs to that of the target tab
+ * @param {Object} log The candidate log
+ * @return {Object} The transformed log
+ */
+function injectSessions(log) {
+ let id = log.details.id;
+ if(id in tabToHttpSession) {
+ log.httpSession = tabToHttpSession[id];
+ } else {
+ log.httpSession = null
+ }
+ log.browserSessionId = browserSessionId;
+ return log;
+}
+
browser.storage.local.get(defaultConfig, (res) => {
// Apply url filter to logs generated by the background page.
- userale.addCallbacks({filterUrl});
+ userale.addCallbacks({filterUrl, injectSessions});
updateConfig(res);
+ browserSessionId = JSON.parse(window.sessionStorage.getItem('userAleHttpSessionId'));
});
browser.runtime.onMessage.addListener(function (message, sender, sendResponse) {
@@ -74,9 +107,7 @@
// Handles logs rerouted from content and option scripts.
case MessageTypes.ADD_LOG:
let log = message.payload;
- if("tab" in sender && "id" in sender.tab) {
- log["tabId"] = sender.tab.id;
- }
+ log.browserSessionId = browserSessionId;
// Apply url filter to logs generated outside the background page.
log = filterUrl(log);
if(log) {
@@ -84,6 +115,12 @@
}
break;
+ case MessageTypes.HTTP_SESSION:
+ if("tab" in sender && "id" in sender.tab) {
+ tabToHttpSession[sender.tab.id] = message.payload;
+ }
+ break;
+
case MessageTypes.CONFIG_CHANGE:
updateConfig(message.payload);
break;
@@ -93,15 +130,28 @@
}
});
-// Helper functions for logging tab events
+/**
+ * Extract tab details then log a tab event
+ * @param {integer} tabId The id of the target tab
+ * @param {Object} data The data of the tab event
+ * @param {String} type The type of tab event
+ * @return {undefined}
+ */
function packageTabLog(tabId, data, type) {
browser.tabs.get(tabId, (tab) => {
packageDetailedTabLog(tab, data, type);
});
}
+/**
+ * Log a tab event with tab details
+ * @param {Object} tab The target tab object
+ * @param {Object} data The data of the tab event
+ * @param {String} type The type of tab event
+ * @return {undefined}
+ */
function packageDetailedTabLog(tab, data, type) {
- Object.assign(data, {'tabEvent': type});
+ Object.assign(data, {type});
userale.packageCustomLog(data, ()=>{return tab}, true);
}
diff --git a/src/UserALEWebExtension/content.js b/src/UserALEWebExtension/content.js
index 2e7bbf9..b0fe393 100644
--- a/src/UserALEWebExtension/content.js
+++ b/src/UserALEWebExtension/content.js
@@ -24,6 +24,10 @@
browser.storage.local.get("useraleConfig", (res) => {
userale.options(res.useraleConfig);
userale.addCallbacks({rerouteLog});
+
+ // Send httpSession to background scirpt to inject into tab events.
+ let payload = JSON.parse(window.sessionStorage.getItem('userAleHttpSessionId'));
+ browser.runtime.sendMessage({type: MessageTypes.HTTP_SESSION, payload});
});
browser.runtime.onMessage.addListener(function (message) {
diff --git a/src/UserALEWebExtension/messageTypes.js b/src/UserALEWebExtension/messageTypes.js
index e8796f1..6d553c9 100644
--- a/src/UserALEWebExtension/messageTypes.js
+++ b/src/UserALEWebExtension/messageTypes.js
@@ -19,3 +19,4 @@
export const CONFIG_CHANGE = prefix + 'CONFIG_CHANGE';
export const ADD_LOG = prefix + 'ADD_LOG';
+export const HTTP_SESSION = prefix + 'HTTP_SESSION';
diff --git a/src/getInitialSettings.js b/src/getInitialSettings.js
index b9624eb..99f35f0 100644
--- a/src/getInitialSettings.js
+++ b/src/getInitialSettings.js
@@ -16,6 +16,7 @@
*/
let sessionId = null;
+let httpSessionId = null;
/**
* Extracts the initial configuration settings from the
@@ -29,6 +30,10 @@
sessionId = getSessionId('userAleSessionId', 'session_' + String(Date.now()));
}
+ if (httpSessionId === null) {
+ httpSessionId = getSessionId('userAleHttpSessionId', generateHttpSessionId());
+ }
+
const script = document.currentScript || (function () {
const scripts = document.getElementsByTagName('script');
return scripts[scripts.length - 1];
@@ -49,6 +54,8 @@
settings.userFromParams = get('data-user-from-params') || null;
settings.time = timeStampScale(document.createEvent('CustomEvent'));
settings.sessionID = get('data-session') || sessionId;
+ settings.httpSessionId = httpSessionId;
+ settings.browserSessionId = null;
settings.authHeader = get('data-auth') || null;
settings.custIndex = get('data-index') || null;
settings.headers = get('data-headers') || null;
@@ -70,7 +77,6 @@
return JSON.parse(window.sessionStorage.getItem(sessionKey));
}
-
/**
* Creates a function to normalize the timestamp of the provided event.
* @param {Object} e An event containing a timeStamp property.
@@ -108,3 +114,19 @@
return tsScaler;
}
+
+/**
+ * Creates a cryptographiclly random string to represent this http session.
+ * @return {String} A random 32 digit hex string
+ */
+function generateHttpSessionId() {
+ // 32 digit hex -> 128 bits of info -> 2^64 ~= 10^19 sessions needed for 50% chance of collison
+ let len = 32;
+ var arr = new Uint8Array(len / 2);
+ window.crypto.getRandomValues(arr);
+ return Array.from(arr,
+ (dec) => {
+ return dec.toString(16).padStart(2, "0");
+ }
+ ).join('');
+}
diff --git a/src/packageLogs.js b/src/packageLogs.js
index 637a986..0a23935 100644
--- a/src/packageLogs.js
+++ b/src/packageLogs.js
@@ -144,6 +144,8 @@
'toolName' : config.toolName,
'useraleVersion': config.useraleVersion,
'sessionID': config.sessionID,
+ 'httpSessionId': config.httpSessionId,
+ 'browserSessionId': config.browserSessionId,
};
if ((typeof filterHandler === 'function') && !filterHandler(log)) {
@@ -198,7 +200,9 @@
'toolVersion' : config.version,
'toolName' : config.toolName,
'useraleVersion': config.useraleVersion,
- 'sessionID': config.sessionID
+ 'sessionID': config.sessionID,
+ 'httpSessionId': config.httpSessionId,
+ 'browserSessionId': config.browserSessionId,
};
let log = Object.assign(metaData, customLog);
@@ -282,7 +286,9 @@
'toolVersion': config.version,
'toolName': config.toolName,
'useraleVersion': config.useraleVersion,
- 'sessionID': config.sessionID
+ 'sessionID': config.sessionID,
+ 'httpSessionId': config.httpSessionId,
+ 'browserSessionId': config.browserSessionId,
};
if (typeof filterHandler === 'function' && !filterHandler(intervalLog)) {
diff --git a/test/main_spec.js b/test/main_spec.js
index 5bc045a..084561a 100644
--- a/test/main_spec.js
+++ b/test/main_spec.js
@@ -32,6 +32,8 @@
'logCountThreshold',
'userId',
'sessionID',
+ 'httpSessionId',
+ 'browserSessionId',
'version',
'logDetails',
'resolution',
