Merge branch 'test' into dependabot/npm_and_yarn/test/jsdom-and-global-jsdom-23.0.1
diff --git a/build/UserALEWebExtension/background.js b/build/UserALEWebExtension/background.js
index 126c474..5b7123b 100644
--- a/build/UserALEWebExtension/background.js
+++ b/build/UserALEWebExtension/background.js
@@ -1,31 +1,3 @@
-/*
-* 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.
-*/
-
-/* eslint-disable */
-
-// these are default values, which can be overridden by the user on the options page
-var userAleHost = 'http://localhost:8000';
-var userAleScript = 'userale-2.4.0.min.js';
-var toolUser = 'nobody';
-var toolName = 'test_app';
-var toolVersion = '2.4.0';
-
-/* eslint-enable */
-
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
@@ -47,6 +19,18 @@
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
@@ -64,6 +48,56 @@
* 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.
@@ -102,6 +136,62 @@
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)) {
@@ -325,7 +415,153 @@
* limitations under the License.
*/
-detect();
+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.
@@ -340,6 +576,165 @@
};
}
+/**
+ * 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
@@ -357,6 +752,198 @@
* 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;
/**
@@ -397,8 +984,13 @@
* @param {Object} config Configuration object to be read from.
*/
function sendOnClose(logs, config) {
- window.addEventListener('pagehide', function () {
+ 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
}
@@ -416,14 +1008,20 @@
// @todo expose config object to sendLogs replate url with config.url
function sendLogs(logs, config, retries) {
var req = new XMLHttpRequest();
-
- // @todo setRequestHeader for Auth
var data = JSON.stringify(logs);
- req.open('POST', config.url);
+ req.open("POST", config.url);
if (config.authHeader) {
- req.setRequestHeader('Authorization', config.authHeader);
+ req.setRequestHeader("Authorization", config.authHeader);
}
- req.setRequestHeader('Content-type', 'application/json;charset=UTF-8');
+ 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) {
@@ -434,6 +1032,103 @@
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
@@ -452,48 +1147,27 @@
*/
-// inherent dependency on globals.js, loaded by the webext
-
-// browser is defined in firefox, but not in chrome. In chrome, they use
-// the 'chrome' global instead. Let's map it to browser so we don't have
-// to have if-conditions all over the place.
-
-var browser = browser || chrome;
-var logs = [];
-var config = {
- autostart: true,
- url: 'http://localhost:8000',
- transmitInterval: 5000,
- logCountThreshold: 5,
- userId: null,
- version: null,
- resolution: 500,
- time: timeStampScale({}),
- on: true
+// 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 sessionId = 'session_' + Date.now();
-var getTimestamp = typeof performance !== 'undefined' && typeof performance.now !== 'undefined' ? function () {
- return performance.now() + performance.timing.navigationStart;
-} : Date.now;
-browser.storage.local.set({
- sessionId: sessionId
-});
-browser.storage.local.get({
- userAleHost: userAleHost,
- userAleScript: userAleScript,
- toolUser: toolUser,
- toolName: toolName,
- toolVersion: toolVersion
-}, storeCallback);
-function storeCallback(item) {
- config = Object.assign({}, config, {
- url: item.userAleHost,
- userId: item.toolUser,
- sessionID: sessionId,
- toolName: item.toolName,
- toolVersion: item.toolVersion
- });
- initSender(logs, config);
+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) {
@@ -502,107 +1176,86 @@
});
});
}
-function packageBrowserLog(type, logDetail) {
- var timeFields = extractTimeFields(getTimestamp());
- logs.push({
- 'target': null,
- 'path': null,
- 'clientTime': timeFields.milli,
- 'microTime': timeFields.micro,
- 'location': null,
- 'type': 'browser.' + type,
- 'logType': 'raw',
- 'userAction': true,
- 'details': logDetail,
- 'userId': toolUser,
- 'toolVersion': null,
- 'toolName': null,
- 'useraleVersion': null,
- 'sessionID': sessionId
- });
+
+// 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.runtime.onMessage.addListener(function (message) {
+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) {
- case CONFIG_CHANGE:
- (function () {
- var updatedConfig = Object.assign({}, config, {
- url: message.payload.userAleHost,
- userId: message.payload.toolUser,
- toolName: message.payload.toolName,
- toolVersion: message.payload.toolVersion
- });
- initSender(logs, updatedConfig);
- dispatchTabMessage(message);
- })();
- break;
+ // Handles logs rerouted from content and option scripts.
case ADD_LOG:
- (function () {
- logs.push(message.payload);
- })();
+ 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);
}
});
-function getTabDetailById(tabId, onReady) {
+
+// Helper functions for logging tab events
+function packageTabLog(tabId, data, type) {
browser.tabs.get(tabId, function (tab) {
- onReady({
- active: tab.active,
- audible: tab.audible,
- incognito: tab.incognito,
- index: tab.index,
- muted: tab.mutedInfo ? tab.mutedInfo.muted : null,
- pinned: tab.pinned,
- selected: tab.selected,
- tabId: tab.id,
- title: tab.title,
- url: tab.url,
- windowId: tab.windowId
- });
+ packageDetailedTabLog(tab, data, type);
});
}
-browser.tabs.onActivated.addListener(function (e) {
- getTabDetailById(e.tabId, function (detail) {
- packageBrowserLog('tabs.onActivated', detail);
+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.onCreated.addListener(function (tab, e) {
- packageBrowserLog('tabs.onCreated', {
- active: tab.active,
- audible: tab.audible,
- incognito: tab.incognito,
- index: tab.index,
- muted: tab.mutedInfo ? tab.mutedInfo.muted : null,
- pinned: tab.pinned,
- selected: tab.selected,
- tabId: tab.id,
- title: tab.title,
- url: tab.url,
- windowId: tab.windowId
- });
+browser.tabs.onAttached.addListener(function (tabId, attachInfo) {
+ packageTabLog(tabId, attachInfo, "tabs.onAttached");
});
-browser.tabs.onDetached.addListener(function (tabId) {
- getTabDetailById(tabId, function (detail) {
- packageBrowserLog('tabs.onDetached', detail);
- });
+browser.tabs.onCreated.addListener(function (tab) {
+ packageDetailedTabLog(tab, {}, "tabs.onCreated");
});
-browser.tabs.onMoved.addListener(function (tabId) {
- getTabDetailById(tabId, function (detail) {
- packageBrowserLog('tabs.onMoved', detail);
- });
+browser.tabs.onDetached.addListener(function (tabId, detachInfo) {
+ packageTabLog(tabId, detachInfo, "tabs.onDetached");
});
-browser.tabs.onRemoved.addListener(function (tabId) {
- packageBrowserLog('tabs.onRemoved', {
- tabId: tabId
- });
+browser.tabs.onMoved.addListener(function (tabId, moveInfo) {
+ packageTabLog(tabId, moveInfo, "tabs.onMoved");
});
-browser.tabs.onZoomChange.addListener(function (e) {
- getTabDetailById(e.tabId, function (detail) {
- packageBrowserLog('tabs.onZoomChange', Object.assign({}, {
- oldZoomFactor: e.oldZoomFactor,
- newZoomFactor: e.newZoomFactor
- }, detail));
- });
+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");
});
/*
diff --git a/build/UserALEWebExtension/content.js b/build/UserALEWebExtension/content.js
index 2ec7e1f..8dcf1de 100644
--- a/build/UserALEWebExtension/content.js
+++ b/build/UserALEWebExtension/content.js
@@ -1,31 +1,3 @@
-/*
-* 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.
-*/
-
-/* eslint-disable */
-
-// these are default values, which can be overridden by the user on the options page
-var userAleHost = 'http://localhost:8000';
-var userAleScript = 'userale-2.4.0.min.js';
-var toolUser = 'nobody';
-var toolName = 'test_app';
-var toolVersion = '2.4.0';
-
-/* eslint-enable */
-
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
@@ -99,6 +71,7 @@
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;
}
@@ -432,7 +405,7 @@
* limitations under the License.
*/
-var browser$1 = detect();
+var browserInfo = detect();
var logs$1;
var config$1;
@@ -747,8 +720,8 @@
}
function detectBrowser() {
return {
- 'browser': browser$1 ? browser$1.name : '',
- 'version': browser$1 ? browser$1.version : ''
+ 'browser': browserInfo ? browserInfo.name : '',
+ 'version': browserInfo ? browserInfo.version : ''
};
}
@@ -906,22 +879,60 @@
return true;
}
-/*
- * 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.
- */
+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;
@@ -963,8 +974,13 @@
* @param {Object} config Configuration object to be read from.
*/
function sendOnClose(logs, config) {
- window.addEventListener('pagehide', function () {
+ 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
}
@@ -982,14 +998,20 @@
// @todo expose config object to sendLogs replate url with config.url
function sendLogs(logs, config, retries) {
var req = new XMLHttpRequest();
-
- // @todo setRequestHeader for Auth
var data = JSON.stringify(logs);
- req.open('POST', config.url);
+ req.open("POST", config.url);
if (config.authHeader) {
- req.setRequestHeader('Authorization', config.authHeader);
+ req.setRequestHeader("Authorization", config.authHeader);
}
- req.setRequestHeader('Content-type', 'application/json;charset=UTF-8');
+ 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) {
@@ -1033,7 +1055,6 @@
started = config.on = true;
packageCustomLog({
type: 'load',
- logType: 'raw',
details: {
pageLoadTime: endLoadTimestamp - startLoadTimestamp
}
@@ -1058,6 +1079,37 @@
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
@@ -1075,59 +1127,15 @@
* limitations under the License.
*/
-
-// browser is defined in firefox, but not in chrome. In chrome, they use
-// the 'chrome' global instead. Let's map it to browser so we don't have
-// to have if-conditions all over the place.
-
-var browser = browser || chrome;
-
-// creates a Future for retrieval of the named keys
-// the value specified is the default value if one doesn't exist in the storage
-browser.storage.local.get({
- sessionId: null,
- userAleHost: userAleHost,
- userAleScript: userAleScript,
- toolUser: toolUser,
- toolName: toolName,
- toolVersion: toolVersion
-}, storeCallback);
-function storeCallback(item) {
- injectScript({
- url: item.userAleHost,
- userId: item.toolUser,
- sessionID: item.sessionId,
- toolName: item.toolName,
- toolVersion: item.toolVersion
- });
-}
-function queueLog(log) {
- browser.runtime.sendMessage({
- type: ADD_LOG,
- payload: log
- });
-}
-function injectScript(config) {
- options(config);
- // start(); not necessary given that autostart in place, and option is masked from WebExt users
+browser.storage.local.get("useraleConfig", function (res) {
+ options(res.useraleConfig);
addCallbacks({
- "function": function _function(log) {
- queueLog(Object.assign({}, log, {
- pageUrl: document.location.href
- }));
- console.log(log);
- return false;
- }
+ rerouteLog: rerouteLog
});
-}
+});
browser.runtime.onMessage.addListener(function (message) {
if (message.type === CONFIG_CHANGE) {
- options({
- url: message.payload.userAleHost,
- userId: message.payload.toolUser,
- toolName: message.payload.toolName,
- toolVersion: message.payload.toolVersion
- });
+ options(message.payload);
}
});
diff --git a/build/UserALEWebExtension/options.js b/build/UserALEWebExtension/options.js
index 1495455..ba97986 100644
--- a/build/UserALEWebExtension/options.js
+++ b/build/UserALEWebExtension/options.js
@@ -1,31 +1,3 @@
-/*
-* 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.
-*/
-
-/* eslint-disable */
-
-// these are default values, which can be overridden by the user on the options page
-var userAleHost = 'http://localhost:8000';
-var userAleScript = 'userale-2.4.0.min.js';
-var toolUser = 'nobody';
-var toolName = 'test_app';
-var toolVersion = '2.4.0';
-
-/* eslint-enable */
-
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
@@ -45,6 +17,1067 @@
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
@@ -63,42 +1096,81 @@
* limitations under the License.
*/
-if (chrome) {
- browser = chrome;
+
+// 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;
}
-// creates a Future for retrieval of the named keys
-// the value specified is the default value if one doesn't exist in the storage
-browser.storage.local.get({
- userAleHost: userAleHost,
- userAleScript: userAleScript,
- toolUser: toolUser,
- toolName: toolName,
- toolVersion: toolVersion
-}, storeCallback);
-function storeCallback(item) {
- document.getElementById("host").value = item.userAleHost;
- document.getElementById("clientScript").value = item.userAleScript;
- document.getElementById("toolUser").value = item.toolUser;
- document.getElementById("toolName").value = item.toolName;
- document.getElementById("toolVersion").value = item.toolVersion;
-}
-function saveOptions(e) {
- var updatedConfig = {
- userAleHost: document.getElementById("host").value,
- userAleScript: document.getElementById("clientScript").value,
- toolUser: document.getElementById("toolUser").value,
- toolName: document.getElementById("toolName").value,
- toolVersion: document.getElementById("toolVersion").value
+/* 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
};
- browser.storage.local.set(updatedConfig);
- browser.runtime.sendMessage({
- type: CONFIG_CHANGE,
- payload: updatedConfig
+
+ // 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
+ });
});
}
-document.addEventListener("submit", function () {
- saveOptions();
-});
+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
index b746439..9a3f363 100644
--- a/build/UserALEWebExtension/optionsPage.html
+++ b/build/UserALEWebExtension/optionsPage.html
@@ -19,31 +19,34 @@
<html>
<head>
<title>User ALE Web Extension - Options</title>
- <script src="globals.js"></script>
<script src="options.js"></script>
<meta charset="utf-8">
</head>
<body>
<h1>Options</h1>
<form>
- <label>User ALE Server Host:</label>
- <input id="host"/>
- <br/>
-
- <label>User ALE Client Script:</label>
- <input id="clientScript"/>
+ <label>Logging Endpoint URL:</label>
+ <input id="url"/>
<br/>
<label>User:</label>
- <input id="toolUser"/>
+ <input id="user"/>
+ <br/>
+
+ <label>Password:</label>
+ <input type="password" id="password"/>
<br/>
<label>Tool Name:</label>
- <input id="toolName"/>
+ <input id="tool"/>
<br/>
<label>Tool Version:</label>
- <input id="toolVersion"/>
+ <input id="version"/>
+ <br/>
+
+ <label>URL whitelist regex:</label>
+ <input id="filter"/>
<br/>
<div align="right">
diff --git a/build/userale-2.4.0.js b/build/userale-2.4.0.js
index 6b89cc4..5fc18af 100644
--- a/build/userale-2.4.0.js
+++ b/build/userale-2.4.0.js
@@ -84,6 +84,7 @@
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;
}
@@ -417,7 +418,7 @@
* limitations under the License.
*/
- var browser = detect();
+ var browserInfo = detect();
var logs$1;
var config$1;
@@ -744,8 +745,8 @@
}
function detectBrowser() {
return {
- 'browser': browser ? browser.name : '',
- 'version': browser ? browser.version : ''
+ 'browser': browserInfo ? browserInfo.name : '',
+ 'version': browserInfo ? browserInfo.version : ''
};
}
@@ -968,6 +969,61 @@
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
@@ -975,9 +1031,9 @@
* 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.
@@ -985,6 +1041,59 @@
* 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;
/**
@@ -1025,8 +1134,13 @@
* @param {Object} config Configuration object to be read from.
*/
function sendOnClose(logs, config) {
- window.addEventListener('pagehide', function () {
+ 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
}
@@ -1044,14 +1158,23 @@
// @todo expose config object to sendLogs replate url with config.url
function sendLogs(logs, config, retries) {
var req = new XMLHttpRequest();
-
- // @todo setRequestHeader for Auth
var data = JSON.stringify(logs);
- req.open('POST', config.url);
+ req.open("POST", config.url);
+
+ // Update headers
+ updateAuthHeader(config);
if (config.authHeader) {
- req.setRequestHeader('Authorization', config.authHeader);
+ req.setRequestHeader("Authorization", config.authHeader);
}
- req.setRequestHeader('Content-type', 'application/json;charset=UTF-8');
+ 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) {
@@ -1095,7 +1218,6 @@
exports.started = config.on = true;
packageCustomLog({
type: 'load',
- logType: 'raw',
details: {
pageLoadTime: endLoadTimestamp - startLoadTimestamp
}
@@ -1164,6 +1286,7 @@
exports.options = options;
exports.packageCustomLog = packageCustomLog;
exports.packageLog = packageLog;
+ exports.registerAuthCallback = registerAuthCallback;
exports.removeCallbacks = removeCallbacks;
exports.start = start;
exports.stop = stop;
diff --git a/build/userale-2.4.0.min.js b/build/userale-2.4.0.min.js
index 81d0c30..e87a122 100644
--- a/build/userale-2.4.0.min.js
+++ b/build/userale-2.4.0.min.js
@@ -15,4 +15,4 @@
* 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",o=null;function r(e,t){var n=e.autostart,o=t.autostart;Object.keys(t).forEach((function(n){if("userFromParams"===n){var o=(r=t[n],i=new RegExp("[?&]"+r+"(=([^&#]*)|&|#|$)"),(a=window.location.href.match(i))&&a[2]?decodeURIComponent(a[2].replace(/\+/g," ")):null);o&&(e.userId=o)}var r,i,a;e[n]=t[n]})),!1!==n&&!1!==o||(e.autostart=!1)}var i=function(e,t,n){if(n||2===arguments.length)for(var o,r=0,i=t.length;r<i;r++)!o&&r in t||(o||(o=Array.prototype.slice.call(t,0,r)),o[r]=t[r]);return e.concat(o||Array.prototype.slice.call(t))},a=function(e,t,n){this.name=e,this.version=t,this.os=n,this.type="browser"},s=function(e){this.version=e,this.type="node",this.name="node",this.os=process.platform},l=function(e,t,n,o){this.name=e,this.version=t,this.os=n,this.bot=o,this.type="bot-device"},u=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/]],p=[["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 w(e){var t=function(e){return""!==e&&m.reduce((function(t,n){var o=n[0],r=n[1];if(t)return t;var i=r.exec(e);return!!i&&[o,i]}),!1)}(e);if(!t)return null;var n=t[0],o=t[1];if("searchbot"===n)return new u;var r=o[1]&&o[1].split(".").join("_").split("_").slice(0,3);r?r.length<f&&(r=i(i([],r,!0),function(e){for(var t=[],n=0;n<e;n++)t.push("0");return t}(f-r.length),!0)):r=[];var s=r.join("."),c=function(e){for(var t=0,n=p.length;t<n;t++){var o=p[t],r=o[0];if(o[1].exec(e))return r}return null}(e),w=d.exec(e);return w&&w[1]?new l(n,s,c,w[1]):new a(n,s,c)}var h,g,v,y,b,S,O,k,W,E,T,I,N=h?w(h):"undefined"==typeof document&&"undefined"!=typeof navigator&&"ReactNative"===navigator.product?new c:"undefined"!=typeof navigator?w(navigator.userAgent):"undefined"!=typeof process&&process.version?new s(process.version.slice(1)):null,x={};function D(e,t){if(!v.on)return!1;var n=null;t&&(n=t(e));for(var o,r=(o=e.timeStamp&&e.timeStamp>0?v.time(e.timeStamp):Date.now(),{milli:Math.floor(o),micro:Number((o%1).toFixed(3))}),i={target:B(e.target),path:P(e),pageUrl:window.location.href,pageTitle:document.title,pageReferrer:document.referrer,browser:j(),clientTime:r.milli,microTime:r.micro,location:A(e),scrnRes:M(),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,s=Object.values(x);a<s.length;a++){var l=s[a];if("function"==typeof l&&!(i=l(i,e)))return!1}return g.push(i),!0}function C(e,t,n){if(!v.on)return!1;var o=null;t&&(o=t());for(var r={pageUrl:window.location.href,pageTitle:document.title,pageReferrer:document.referrer,browser:j(),clientTime:Date.now(),scrnRes:M(),logType:"custom",userAction:n,details:o,userId:v.userId,toolVersion:v.version,toolName:v.toolName,useraleVersion:v.useraleVersion,sessionID:v.sessionID},i=Object.assign(r,e),a=0,s=Object.values(x);a<s.length;a++){var l=s[a];if("function"==typeof l&&!(i=l(i,null)))return!1}return g.push(i),!0}function A(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 M(){return{width:window.innerWidth,height:window.innerHeight}}function B(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 P(e){if(e instanceof window.Event)return function(e){var t,n=0,o=[];for(;t=e[n];)o.push(B(t)),++n;return o}(e.composedPath())}function j(){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 X(e){return function(e){E={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},T={},I={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(E).forEach((function(e){document.addEventListener(e,(function(t){D(t,E[e])}),!0)})),V.forEach((function(e){document.addEventListener(e,(function(e){!function(e){var t=B(e.target),n=P(e),o=e.type,r=Math.floor(e.timeStamp&&e.timeStamp>0?v.time(e.timeStamp):Date.now());if(null==y&&(y=t,b=o,S=n,O=r,k=0),y!==t||b!==o){W={target:y,path:S,pageUrl:window.location.href,pageTitle:document.title,pageReferrer:document.referrer,browser:j(),count:k,duration:r-O,startTime:O,endTime:r,type:b,logType:"interval",targetChange:y!==t,typeChange:b!==o,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 s=a[i];if("function"==typeof s&&!(W=s(W,null)))return!1}g.push(W),y=t,b=o,S=n,O=r,k=0}y==t&&b==o&&(k+=1)}(e)}),!0)})),Object.keys(I).forEach((function(t){T[t]=!0,window.addEventListener(t,(function(n){T[t]&&(T[t]=!1,D(n,I[t]),setTimeout((function(){T[t]=!0}),e.resolution))}),!0)})),Object.keys(K).forEach((function(e){document.addEventListener(e,(function(t){D(t,E[e])}),!0)})),L.forEach((function(e){window.addEventListener(e,(function(e){D(e,(function(){return{window:!0}}))}),!0)})),!0}var $=null;function _(e,t){null!==$&&clearInterval($),$=function(e,t){return setInterval((function(){t.on&&e.length>=t.logCountThreshold&&(H(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 H(e,t,n){var o=new XMLHttpRequest,r=JSON.stringify(e);o.open("POST",t.url),t.authHeader&&o.setRequestHeader("Authorization",t.authHeader),o.setRequestHeader("Content-type","application/json;charset=UTF-8"),o.onreadystatechange=function(){4===o.readyState&&200!==o.status&&n>0&&H(e,t,n--)},o.send(r)}var z,F={},Y=[],J=Date.now();window.onload=function(){z=Date.now()},e.started=!1,F.on=!1,F.useraleVersion=n,r(F,function(){var e={};null===o&&(o=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],r=n?n.getAttribute.bind(n):function(){return null};return e.autostart="false"!==r("data-autostart"),e.url=r("data-url")||"http://localhost:8000",e.transmitInterval=+r("data-interval")||5e3,e.logCountThreshold=+r("data-threshold")||5,e.userId=r("data-user")||null,e.version=r("data-version")||null,e.logDetails="true"===r("data-log-details"),e.resolution=+r("data-resolution")||500,e.toolName=r("data-tool")||null,e.userFromParams=r("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 o=performance.timing.navigationStart;t=function(e){return e+o}}else t=function(e){return e}}else t=function(){return Date.now()};return t}(document.createEvent("CustomEvent")),e.sessionID=r("data-session")||o,e.authHeader=r("data-auth")||null,e.custIndex=r("data-index")||null,e}()),g=Y,v=F,x=[],y=null,b=null,S=null,O=null,k=0,W=null,F.autostart&&function t(n){e.started||setTimeout((function(){var o=document.readyState;!n.autostart||"interactive"!==o&&"complete"!==o?t(n):(X(n),_(Y,n),e.started=n.on=!0,C({type:"load",logType:"raw",details:{pageLoadTime:z-J}},(function(){}),!1))}),100)}(F);var U=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 o=Object.getOwnPropertyDescriptor(e,n);o.enumerable&&(t[n]=o)})),Object.defineProperties(x,t)})),x},e.buildPath=P,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=B,e.log=function(e){return null!==e&&"object"===t(e)&&(Y.push(e),!0)},e.options=function(e){return void 0!==e&&r(F,e),F},e.packageCustomLog=C,e.packageLog=D,e.removeCallbacks=function(e){e.forEach((function(e){Object.hasOwn(x,e)&&delete x[e]}))},e.start=function(){e.started&&!1!==F.autostart||(e.started=F.on=!0,F.autostart=!0)},e.stop=function(){e.started=F.on=!1,F.autostart=!1},e.version=U}));
+!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/example/log-label-example/README.md b/example/log-label-example/README.md
index 1b6b159..a17a89e 100644
--- a/example/log-label-example/README.md
+++ b/example/log-label-example/README.md
@@ -6,6 +6,9 @@
## Adding Custom Labels to Logs
+#### Important Note
+Please be aware that when adding custom logs without disabling raw logging for those specific logs, duplicate log entries will be generated: one for raw logs and another for custom logs.
+
### Example 1
Consider the following HTML:
@@ -59,4 +62,4 @@
Note that we only advise adding custom event listeners in the following scenarios:
1. For events not captured natively by UserALE.js (as seen above)
-2. For sending custom logs *only*
\ No newline at end of file
+2. For sending custom logs *only*
diff --git a/example/log.schema.json b/example/log.schema.json
new file mode 100644
index 0000000..e138c7f
--- /dev/null
+++ b/example/log.schema.json
@@ -0,0 +1,125 @@
+{
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
+ "$id": "https://flagon.incubator.apache.org/log.schema.json",
+ "title": "Log",
+ "description": "A raw or custom log produced by userale",
+ "type": "object",
+ "properties": {
+ "target": {
+ "type": "string"
+ },
+ "path": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "minItems": 1
+ },
+ "pageUrl": {
+ "type": "string"
+ },
+ "pageTitle": {
+ "type": "string"
+ },
+ "browser": {
+ "type": "object",
+ "properties": {
+ "browser": {
+ "type": "string"
+ },
+ "version": {
+ "type": "string"
+ }
+ },
+ "required" : ["browser", "version"]
+ },
+ "clientTime": {
+ "type": "integer"
+ },
+ "microTime": {
+ "type": "number",
+ "minimum": 0,
+ "maxmaximumi": 1
+ },
+ "location": {
+ "type": "object",
+ "properties": {
+ "x": {
+ "type": ["integer", "null"]
+ },
+ "y": {
+ "type": ["integer", "null"]
+ }
+ },
+ "required" : ["x", "y"]
+ },
+ "scrnRes": {
+ "type": "object",
+ "properties": {
+ "height": {
+ "type": "integer"
+ },
+ "width": {
+ "type": "integer"
+ }
+ },
+ "required" : ["height", "width"]
+ },
+ "type": {
+ "type": "string"
+ },
+ "logType": {
+ "type": "string",
+ "enum": ["raw", "custom"]
+ },
+ "userAction": {
+ "type": "boolean"
+ },
+ "details": {
+ "type": "object"
+ },
+ "userId": {
+ "type": "string"
+ },
+ "toolVersion": {
+ "type": "string"
+ },
+ "toolName": {
+ "type": "string"
+ },
+ "useraleVersion": {
+ "type": "string"
+ },
+ "sessionID": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "pageUrl",
+ "pageTitle",
+ "pageReferrer",
+ "browser",
+ "clientTime",
+ "scrnRes",
+ "logType",
+ "userAction",
+ "details",
+ "userId",
+ "toolVersion",
+ "toolName",
+ "useraleVersion",
+ "sessionID"
+ ],
+ "if": {
+ "properties": { "logType": { "const": "raw" } }
+ },
+ "then": {
+ "required": [
+ "target",
+ "path",
+ "microTime",
+ "location",
+ "type"
+ ]
+ }
+}
\ No newline at end of file
diff --git a/journey/userale.journey.cy.js b/journey/userale.journey.cy.js
index 1a73d39..cb8d28d 100644
--- a/journey/userale.journey.cy.js
+++ b/journey/userale.journey.cy.js
@@ -14,6 +14,8 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+import { validate } from 'jsonschema';
+
describe('Userale logging', () => {
beforeEach(() => {
cy.intercept('POST', 'http://localhost:8000/').as('backend')
@@ -26,7 +28,7 @@
const pageLoadLog = body[0]
expect(pageLoadLog['details']['pageLoadTime']).to.be.greaterThan(0)
expect(pageLoadLog).to.contain({
- logType: 'raw',
+ logType: 'custom',
type: 'load'
})
})
@@ -62,4 +64,24 @@
expect(actualValue).to.equal(expectedValue)
})
});
+
+ it('produces valid logs', () => {
+ cy.visit('http://localhost:8000');
+ cy.wait('@backend').then(xhr => {
+ var schema = require('../example/log.schema.json');
+ for(const log of xhr.request.body) {
+ const result = validate(log, schema);
+ expect(result.valid, result.errors).to.equal(true);
+ }
+ })
+ cy.contains(/click me/i).click();
+ cy.wait('@backend').then(xhr => {
+ var schema = require('../example/log.schema.json');
+ for(const log of xhr.request.body) {
+ const result = validate(log, schema);
+ expect(result.valid, result.errors).to.equal(true);
+ }
+ })
+ });
+
});
diff --git a/package-lock.json b/package-lock.json
index 7282b29..b8be491 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -21,6 +21,7 @@
"@rollup/plugin-terser": "^0.4.4",
"body-parser": "^1.20.2",
"chai": "^4.3.10",
+ "chai-subset": "^1.6.0",
"cypress": "^13.6.0",
"detect-browser": "^5.3.0",
"dom-storage": "^2.1.0",
@@ -28,6 +29,7 @@
"express": "^4.18.2",
"global-jsdom": "^9.1.0",
"jsdom": "^23.0.1",
+ "jsonschema": "^1.4.1",
"mocha": "^10.2.0",
"nodemon": "^3.0.2",
"rollup": "^4.6.1",
@@ -3128,6 +3130,15 @@
"node": ">=4"
}
},
+ "node_modules/chai-subset": {
+ "version": "1.6.0",
+ "resolved": "https://registry.npmjs.org/chai-subset/-/chai-subset-1.6.0.tgz",
+ "integrity": "sha512-K3d+KmqdS5XKW5DWPd5sgNffL3uxdDe+6GdnJh3AYPhwnBGRY5urfvfcbRtWIvvpz+KxkL9FeBB6MZewLUNwug==",
+ "dev": true,
+ "engines": {
+ "node": ">=4"
+ }
+ },
"node_modules/chalk": {
"version": "2.4.2",
"resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz",
@@ -5524,6 +5535,15 @@
"graceful-fs": "^4.1.6"
}
},
+ "node_modules/jsonschema": {
+ "version": "1.4.1",
+ "resolved": "https://registry.npmjs.org/jsonschema/-/jsonschema-1.4.1.tgz",
+ "integrity": "sha512-S6cATIPVv1z0IlxdN+zUk5EPjkGCdnhN4wVSBlvoUO1tOLJootbo9CquNJmbIh4yikWHiUedhRYrNPn1arpEmQ==",
+ "dev": true,
+ "engines": {
+ "node": "*"
+ }
+ },
"node_modules/jsprim": {
"version": "2.0.2",
"resolved": "https://registry.npmjs.org/jsprim/-/jsprim-2.0.2.tgz",
diff --git a/package.json b/package.json
index 1bf08c9..dd84de1 100644
--- a/package.json
+++ b/package.json
@@ -61,6 +61,7 @@
"@rollup/plugin-terser": "^0.4.4",
"body-parser": "^1.20.2",
"chai": "^4.3.10",
+ "chai-subset": "^1.6.0",
"cypress": "^13.6.0",
"detect-browser": "^5.3.0",
"dom-storage": "^2.1.0",
@@ -68,6 +69,7 @@
"express": "^4.18.2",
"global-jsdom": "^9.1.0",
"jsdom": "^23.0.1",
+ "jsonschema": "^1.4.1",
"mocha": "^10.2.0",
"nodemon": "^3.0.2",
"rollup": "^4.6.1",
diff --git a/src/UserALEWebExtension/background.js b/src/UserALEWebExtension/background.js
index 60ebf2e..90160ad 100644
--- a/src/UserALEWebExtension/background.js
+++ b/src/UserALEWebExtension/background.js
@@ -19,58 +19,32 @@
eslint-disable
*/
-import * as globals from './globals';
import * as MessageTypes from './messageTypes.js';
-import { timeStampScale } from '../getInitialSettings.js';
-import { extractTimeFields, initPackager, packageLog } from '../packageLogs.js';
-import { initSender } from '../sendLogs.js';
+import * as userale from '../main.js';
+import { browser } from './globals.js';
-// inherent dependency on globals.js, loaded by the webext
-
-// browser is defined in firefox, but not in chrome. In chrome, they use
-// the 'chrome' global instead. Let's map it to browser so we don't have
-// to have if-conditions all over the place.
-
-var browser = browser || chrome;
-var logs = [];
-var config = {
- autostart: true,
- url: 'http://localhost:8000',
- transmitInterval: 5000,
- logCountThreshold: 5,
- userId: null,
- version: null,
- resolution: 500,
- time: timeStampScale({}),
- on: true,
+// Initalize userale plugin options
+const defaultConfig = {
+ useraleConfig: {
+ url: 'http://localhost:8000',
+ userId: 'pluginUser',
+ authHeader: null,
+ toolName: 'useralePlugin',
+ version: userale.version,
+ },
+ pluginConfig: {
+ // Default to a regex that will match no string
+ urlWhitelist: '(?!x)x'
+ }
};
-var sessionId = 'session_' + Date.now();
-var getTimestamp = ((typeof performance !== 'undefined') && (typeof performance.now !== 'undefined'))
- ? function () { return performance.now() + performance.timing.navigationStart; }
- : Date.now;
+var urlWhitelist;
-browser.storage.local.set({ sessionId: sessionId });
-
-var store = browser.storage.local.get({
- userAleHost: globals.userAleHost,
- userAleScript: globals.userAleScript,
- toolUser: globals.toolUser,
- toolName: globals.toolName,
- toolVersion: globals.toolVersion,
-}, storeCallback);
-
-function storeCallback(item) {
- config = Object.assign({}, config, {
- url: item.userAleHost,
- userId: item.toolUser,
- sessionID: sessionId,
- toolName: item.toolName,
- toolVersion: item.toolVersion
- });
-
- initPackager(logs, config);
- initSender(logs, config);
+function updateConfig(config) {
+ urlWhitelist = new RegExp(config.pluginConfig.urlWhitelist);
+ userale.options(config.useraleConfig);
+ // TODO: tabs need a page load to apply this config change.
+ dispatchTabMessage(config.useraleConfig);
}
function dispatchTabMessage(message) {
@@ -81,47 +55,37 @@
});
}
-function packageBrowserLog(type, logDetail) {
- var timeFields = extractTimeFields(getTimestamp());
-
- logs.push({
- 'target' : null,
- 'path' : null,
- 'clientTime' : timeFields.milli,
- 'microTime' : timeFields.micro,
- 'location' : null,
- 'type' : 'browser.' + type,
- 'logType': 'raw',
- 'userAction' : true,
- 'details' : logDetail,
- 'userId' : globals.toolUser,
- 'toolVersion': null,
- 'toolName': null,
- 'useraleVersion': null,
- 'sessionID': sessionId,
- });
+// 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.runtime.onMessage.addListener(function (message) {
+browser.storage.local.get(defaultConfig, (res) => {
+ // Apply url filter to logs generated by the background page.
+ userale.addCallbacks({filterUrl});
+ updateConfig(res);
+});
+
+browser.runtime.onMessage.addListener(function (message, sender, sendResponse) {
switch (message.type) {
- case MessageTypes.CONFIG_CHANGE:
- (function () {
- var updatedConfig = Object.assign({}, config, {
- url: message.payload.userAleHost,
- userId: message.payload.toolUser,
- toolName: message.payload.toolName,
- toolVersion: message.payload.toolVersion
- });
- initPackager(logs, updatedConfig);
- initSender(logs, updatedConfig);
- dispatchTabMessage(message);
- })();
+ // 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;
+ }
+ // Apply url filter to logs generated outside the background page.
+ log = filterUrl(log);
+ if(log) {
+ userale.log(log);
+ }
break;
- case MessageTypes.ADD_LOG:
- (function () {
- logs.push(message.payload);
- })();
+ case MessageTypes.CONFIG_CHANGE:
+ updateConfig(message.payload);
break;
default:
@@ -129,69 +93,50 @@
}
});
-function getTabDetailById(tabId, onReady) {
- browser.tabs.get(tabId, function (tab) {
- onReady({
- active: tab.active,
- audible: tab.audible,
- incognito: tab.incognito,
- index: tab.index,
- muted: tab.mutedInfo ? tab.mutedInfo.muted : null,
- pinned: tab.pinned,
- selected: tab.selected,
- tabId: tab.id,
- title: tab.title,
- url: tab.url,
- windowId: tab.windowId,
- });
+// Helper functions for logging tab events
+function packageTabLog(tabId, data, type) {
+ browser.tabs.get(tabId, (tab) => {
+ packageDetailedTabLog(tab, data, type);
});
}
-browser.tabs.onActivated.addListener(function (e) {
- getTabDetailById(e.tabId, function (detail) {
- packageBrowserLog('tabs.onActivated', detail);
- });
+function packageDetailedTabLog(tab, data, type) {
+ Object.assign(data, {'tabEvent': type});
+ userale.packageCustomLog(data, ()=>{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((activeInfo) => {
+ packageTabLog(activeInfo.tabId, activeInfo, "tabs.onActivated");
});
-browser.tabs.onCreated.addListener(function (tab, e) {
- packageBrowserLog('tabs.onCreated', {
- active: tab.active,
- audible: tab.audible,
- incognito: tab.incognito,
- index: tab.index,
- muted: tab.mutedInfo ? tab.mutedInfo.muted : null,
- pinned: tab.pinned,
- selected: tab.selected,
- tabId: tab.id,
- title: tab.title,
- url: tab.url,
- windowId: tab.windowId,
- });
+browser.tabs.onAttached.addListener((tabId, attachInfo) => {
+ packageTabLog(tabId, attachInfo, "tabs.onAttached");
});
-browser.tabs.onDetached.addListener(function (tabId) {
- getTabDetailById(tabId, function (detail) {
- packageBrowserLog('tabs.onDetached', detail);
- });
+browser.tabs.onCreated.addListener((tab) => {
+ packageDetailedTabLog(tab, {}, "tabs.onCreated");
});
-browser.tabs.onMoved.addListener(function (tabId) {
- getTabDetailById(tabId, function (detail) {
- packageBrowserLog('tabs.onMoved', detail);
- });
+browser.tabs.onDetached.addListener((tabId, detachInfo) => {
+ packageTabLog(tabId, detachInfo, "tabs.onDetached");
});
-browser.tabs.onRemoved.addListener(function (tabId) {
- packageBrowserLog('tabs.onRemoved', { tabId: tabId });
+browser.tabs.onMoved.addListener((tabId, moveInfo) => {
+ packageTabLog(tabId, moveInfo, "tabs.onMoved");
});
-browser.tabs.onZoomChange.addListener(function (e) {
- getTabDetailById(e.tabId, function (detail) {
- packageBrowserLog('tabs.onZoomChange', Object.assign({}, {
- oldZoomFactor: e.oldZoomFactor,
- newZoomFactor: e.newZoomFactor,
- }, detail));
- });
+browser.tabs.onRemoved.addListener((tabId, removeInfo) => {
+ packageDetailedTabLog({id: tabId}, removeInfo, "tabs.onRemoved");
+});
+
+browser.tabs.onUpdated.addListener((tabId, changeInfo, tab) => {
+ packageDetailedTabLog(tab, changeInfo, "tabs.onUpdated");
+});
+
+browser.tabs.onZoomChange.addListener((ZoomChangeInfo) => {
+ packageTabLog(ZoomChangeInfo.tabId, ZoomChangeInfo, "tabs.onZoomChange");
});
/*
diff --git a/src/UserALEWebExtension/content.js b/src/UserALEWebExtension/content.js
index 7ede7a6..2e7bbf9 100644
--- a/src/UserALEWebExtension/content.js
+++ b/src/UserALEWebExtension/content.js
@@ -17,61 +17,18 @@
/* eslint-disable */
-import * as globals from './globals';
import * as MessageTypes from './messageTypes.js';
-import { addCallbacks, options, start } from '../main.js';
+import * as userale from '../main.js';
+import { rerouteLog, browser } from './globals.js';
-// browser is defined in firefox, but not in chrome. In chrome, they use
-// the 'chrome' global instead. Let's map it to browser so we don't have
-// to have if-conditions all over the place.
-
-var browser = browser || chrome;
-
-// creates a Future for retrieval of the named keys
-// the value specified is the default value if one doesn't exist in the storage
-let store = browser.storage.local.get({
- sessionId: null,
- userAleHost: globals.userAleHost,
- userAleScript: globals.userAleScript,
- toolUser: globals.toolUser,
- toolName: globals.toolName,
- toolVersion: globals.toolVersion,
-}, storeCallback);
-
-function storeCallback(item) {
- injectScript({
- url: item.userAleHost,
- userId: item.toolUser,
- sessionID: item.sessionId,
- toolName: item.toolName,
- toolVersion: item.toolVersion
- });
-}
-
-function queueLog(log) {
- browser.runtime.sendMessage({ type: MessageTypes.ADD_LOG, payload: log });
-}
-
-function injectScript(config) {
- options(config);
-// start(); not necessary given that autostart in place, and option is masked from WebExt users
- addCallbacks({function (log) {
- queueLog(Object.assign({}, log, {
- pageUrl: document.location.href,
- }));
- console.log(log);
- return false;
- }});
-}
+browser.storage.local.get("useraleConfig", (res) => {
+ userale.options(res.useraleConfig);
+ userale.addCallbacks({rerouteLog});
+});
browser.runtime.onMessage.addListener(function (message) {
if (message.type === MessageTypes.CONFIG_CHANGE) {
- options({
- url: message.payload.userAleHost,
- userId: message.payload.toolUser,
- toolName: message.payload.toolName,
- toolVersion: message.payload.toolVersion
- });
+ userale.options(message.payload);
}
});
diff --git a/src/UserALEWebExtension/globals.js b/src/UserALEWebExtension/globals.js
index bda0d7f..1f5d844 100644
--- a/src/UserALEWebExtension/globals.js
+++ b/src/UserALEWebExtension/globals.js
@@ -16,12 +16,14 @@
*/
/* eslint-disable */
+import * as MessageTypes from './messageTypes.js';
-// these are default values, which can be overridden by the user on the options page
-export var userAleHost = 'http://localhost:8000';
-export var userAleScript = 'userale-2.4.0.min.js';
-export var toolUser = 'nobody';
-export var toolName = 'test_app';
-export var toolVersion = '2.4.0';
+// browser is defined in firefox, but chrome uses the 'chrome' global.
+export var browser = browser || chrome;
+
+export function rerouteLog(log) {
+ browser.runtime.sendMessage({ type: MessageTypes.ADD_LOG, payload: log });
+ return false;
+}
/* eslint-enable */
diff --git a/src/UserALEWebExtension/messageTypes.js b/src/UserALEWebExtension/messageTypes.js
index 8eaedbc..e8796f1 100644
--- a/src/UserALEWebExtension/messageTypes.js
+++ b/src/UserALEWebExtension/messageTypes.js
@@ -15,7 +15,7 @@
* limitations under the License.
*/
-var prefix = 'USERALE_';
+const prefix = 'USERALE_';
-export var CONFIG_CHANGE = prefix + 'CONFIG_CHANGE';
-export var ADD_LOG = prefix + 'ADD_LOG';
+export const CONFIG_CHANGE = prefix + 'CONFIG_CHANGE';
+export const ADD_LOG = prefix + 'ADD_LOG';
diff --git a/src/UserALEWebExtension/options.js b/src/UserALEWebExtension/options.js
index 8ef7867..caa442a 100644
--- a/src/UserALEWebExtension/options.js
+++ b/src/UserALEWebExtension/options.js
@@ -16,51 +16,56 @@
*/
/* eslint-disable */
-import * as globals from './globals.js';
import * as MessageTypes from './messageTypes.js';
+import * as userale from '../main.js'
+import { rerouteLog, browser } from './globals.js';
-if (chrome) {
- browser = chrome;
-}
+userale.addCallbacks({rerouteLog});
-// creates a Future for retrieval of the named keys
-// the value specified is the default value if one doesn't exist in the storage
-let store = browser.storage.local.get({
- userAleHost: globals.userAleHost,
- userAleScript: globals.userAleScript,
- toolUser: globals.toolUser,
- toolName: globals.toolName,
- toolVersion: globals.toolVersion,
-}, storeCallback);
+// TODO: Warn users when setting credentials with unsecured connection.
+const mitmWarning = "Setting credentials with http will expose you to a MITM attack. Are you sure you want to continue?";
-function storeCallback(item) {
- document.getElementById("host").value = item.userAleHost;
- document.getElementById("clientScript").value = item.userAleScript;
- document.getElementById("toolUser").value = item.toolUser;
- document.getElementById("toolName").value = item.toolName;
- document.getElementById("toolVersion").value = item.toolVersion;
-}
-
-function onError(error) {
- console.log(error);
-}
-
-function saveOptions(e) {
- const updatedConfig = {
- userAleHost: document.getElementById("host").value,
- userAleScript: document.getElementById("clientScript").value,
- toolUser: document.getElementById("toolUser").value,
- toolName: document.getElementById("toolName").value,
- toolVersion: document.getElementById("toolVersion").value,
+function setConfig() {
+ let config = {
+ url: document.getElementById("url").value,
+ userId: document.getElementById("user").value,
+ toolName: document.getElementById("tool").value,
+ version: document.getElementById("version").value
};
- browser.storage.local.set(updatedConfig);
+ // Set a basic auth header if given credentials.
+ const password = document.getElementById("password").value;
+ if(config.userId && password) {
+ config.authHeader = "Basic " + btoa(`${config.userId}:${password}`);
+ }
- browser.runtime.sendMessage({ type: MessageTypes.CONFIG_CHANGE, payload: updatedConfig });
+ let payload = {
+ useraleConfig: config,
+ pluginConfig: {urlWhitelist: document.getElementById("filter").value}
+ };
+
+ browser.storage.local.set(payload, () => {
+ userale.options(config);
+ browser.runtime.sendMessage({ type: MessageTypes.CONFIG_CHANGE, payload });
+ });
}
-document.addEventListener("submit", function() {
- saveOptions();
-});
+function getConfig() {
+ browser.storage.local.get("useraleConfig", (res) => {
+ let config = res.useraleConfig;
+
+ userale.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", (res) => {
+ document.getElementById("filter").value = res.pluginConfig.urlWhitelist;
+ });
+}
-/* eslint-enable */
+document.addEventListener("DOMContentLoaded", getConfig);
+document.addEventListener("submit", setConfig);
+
+/* eslint-enable */
\ No newline at end of file
diff --git a/src/UserALEWebExtension/optionsPage.html b/src/UserALEWebExtension/optionsPage.html
index b746439..9a3f363 100644
--- a/src/UserALEWebExtension/optionsPage.html
+++ b/src/UserALEWebExtension/optionsPage.html
@@ -19,31 +19,34 @@
<html>
<head>
<title>User ALE Web Extension - Options</title>
- <script src="globals.js"></script>
<script src="options.js"></script>
<meta charset="utf-8">
</head>
<body>
<h1>Options</h1>
<form>
- <label>User ALE Server Host:</label>
- <input id="host"/>
- <br/>
-
- <label>User ALE Client Script:</label>
- <input id="clientScript"/>
+ <label>Logging Endpoint URL:</label>
+ <input id="url"/>
<br/>
<label>User:</label>
- <input id="toolUser"/>
+ <input id="user"/>
+ <br/>
+
+ <label>Password:</label>
+ <input type="password" id="password"/>
<br/>
<label>Tool Name:</label>
- <input id="toolName"/>
+ <input id="tool"/>
<br/>
<label>Tool Version:</label>
- <input id="toolVersion"/>
+ <input id="version"/>
+ <br/>
+
+ <label>URL whitelist regex:</label>
+ <input id="filter"/>
<br/>
<div align="right">
diff --git a/src/getInitialSettings.js b/src/getInitialSettings.js
index 174c642..b9624eb 100644
--- a/src/getInitialSettings.js
+++ b/src/getInitialSettings.js
@@ -51,6 +51,7 @@
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;
}
diff --git a/src/main.js b/src/main.js
index 6d09c71..297fab5 100644
--- a/src/main.js
+++ b/src/main.js
@@ -32,6 +32,7 @@
export let started = false;
export {defineCustomDetails as details} from './attachHandlers.js';
+export {registerAuthCallback as registerAuthCallback} from './utils';
export {
addCallbacks as addCallbacks,
removeCallbacks as removeCallbacks,
@@ -69,7 +70,6 @@
started = config.on = true;
packageCustomLog({
type: 'load',
- logType: 'raw',
details: {pageLoadTime: endLoadTimestamp - startLoadTimestamp}
}, () => {},false)
} else {
diff --git a/src/packageLogs.js b/src/packageLogs.js
index db287d1..637a986 100644
--- a/src/packageLogs.js
+++ b/src/packageLogs.js
@@ -16,7 +16,7 @@
*/
import { detect } from 'detect-browser';
-const browser = detect();
+const browserInfo = detect();
export let logs;
let config;
@@ -391,7 +391,7 @@
export function detectBrowser() {
return {
- 'browser': browser ? browser.name : '',
- 'version': browser ? browser.version : ''
+ 'browser': browserInfo ? browserInfo.name : '',
+ 'version': browserInfo ? browserInfo.version : ''
};
}
\ No newline at end of file
diff --git a/src/sendLogs.js b/src/sendLogs.js
index c2da246..5985644 100644
--- a/src/sendLogs.js
+++ b/src/sendLogs.js
@@ -5,9 +5,9 @@
* 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.
@@ -15,6 +15,9 @@
* limitations under the License.
*/
+import { updateAuthHeader } from "./utils";
+import { updateCustomHeaders } from "./utils/headers";
+
let sendIntervalId = null;
/**
@@ -39,7 +42,7 @@
* @return {Number} The newly created interval id.
*/
export function sendOnInterval(logs, config) {
- return setInterval(function() {
+ return setInterval(function () {
if (!config.on) {
return;
}
@@ -57,8 +60,13 @@
* @param {Object} config Configuration object to be read from.
*/
export function sendOnClose(logs, config) {
- window.addEventListener('pagehide', function () {
+ 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
}
@@ -76,18 +84,27 @@
// @todo expose config object to sendLogs replate url with config.url
export function sendLogs(logs, config, retries) {
const req = new XMLHttpRequest();
-
- // @todo setRequestHeader for Auth
const data = JSON.stringify(logs);
- req.open('POST', config.url);
+ req.open("POST", config.url);
+
+ // Update headers
+ updateAuthHeader(config);
if (config.authHeader) {
- req.setRequestHeader('Authorization', config.authHeader)
+ req.setRequestHeader("Authorization", config.authHeader);
+ }
+ req.setRequestHeader("Content-type", "application/json;charset=UTF-8");
+
+ // Update custom headers last to allow them to over-write the defaults. This assumes
+ // the user knows what they are doing and may want to over-write the defaults.
+ updateCustomHeaders(config);
+ if (config.headers) {
+ Object.entries(config.headers).forEach(([header, value]) => {
+ req.setRequestHeader(header, value);
+ });
}
- req.setRequestHeader('Content-type', 'application/json;charset=UTF-8');
-
- req.onreadystatechange = function() {
+ req.onreadystatechange = function () {
if (req.readyState === 4 && req.status !== 200) {
if (retries > 0) {
sendLogs(logs, config, retries--);
diff --git a/src/utils/auth/index.js b/src/utils/auth/index.js
new file mode 100644
index 0000000..cb8099a
--- /dev/null
+++ b/src/utils/auth/index.js
@@ -0,0 +1,78 @@
+/*
+ * 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.
+ */
+
+export let 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}
+ */
+export 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: ${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.
+ */
+export 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}
+ */
+export function verifyCallback(callback) {
+ if (typeof callback !== "function") {
+ throw new Error("Userale auth callback must be a function");
+ }
+ const result = callback();
+ if (typeof result !== "string") {
+ throw new Error("Userale auth callback must return a string");
+ }
+}
+
+/**
+ * Resets the authCallback to null. Used for primarily for testing, but could be used
+ * to remove the callback in production.
+ * @returns {void}
+ */
+export function resetAuthCallback() {
+ authCallback = null;
+}
\ No newline at end of file
diff --git a/src/utils/headers/index.js b/src/utils/headers/index.js
new file mode 100644
index 0000000..e0c599f
--- /dev/null
+++ b/src/utils/headers/index.js
@@ -0,0 +1,83 @@
+/*
+ * 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.
+ */
+
+export let headersCallback = null;
+
+/**
+ * Fetches the most up-to-date custom headers object from the headers callback
+ * and updates the config object with the new value.
+ * @param {Object} config Configuration object to be updated.
+ * @param {Function} headersCallback Callback used to fetch the newest headers.
+ * @returns {void}
+ */
+export function updateCustomHeaders(config) {
+ if (headersCallback) {
+ try {
+ config.headers = headersCallback();
+ } 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 headersCallback which is the user's
+ // responsibility.
+ console.error(`Error encountered while setting the headers: ${e}`);
+ }
+ }
+}
+
+/**
+ * Registers the provided callback to be used when updating the auth header.
+ * @param {Function} callback Callback used to fetch the newest headers. Should return an object.
+ * @returns {boolean} Whether the operation succeeded.
+ */
+export function registerHeadersCallback(callback) {
+ try {
+ verifyCallback(callback);
+ headersCallback = 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 an object.
+ * @throws {Error} If the callback is not a function or does not return a string.
+ * @returns {void}
+ */
+export function verifyCallback(callback) {
+ if (typeof callback !== "function") {
+ throw new Error("Userale headers callback must be a function");
+ }
+ const result = callback();
+ if (typeof result !== "object") {
+ throw new Error("Userale headers callback must return an object");
+ }
+ for (const [key, value] of Object.entries(result)) {
+ if (typeof key !== "string" || typeof value !== "string") {
+ throw new Error("Userale header callback must return an object with string keys and values");
+ }
+ }
+}
+
+/**
+ * Resets the authCallback to null. Used for primarily for testing, but could be used
+ * to remove the callback in production.
+ * @returns {void}
+ */
+export function resetHeadersCallback() {
+ headersCallback = null;
+}
\ No newline at end of file
diff --git a/src/utils/index.js b/src/utils/index.js
new file mode 100644
index 0000000..243cbbe
--- /dev/null
+++ b/src/utils/index.js
@@ -0,0 +1,30 @@
+/*
+ * 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.
+ */
+export {
+ authCallback,
+ updateAuthHeader,
+ registerAuthCallback,
+ resetAuthCallback,
+ verifyCallback as verifyAuthCallback
+} from "./auth";
+export {
+ headersCallback,
+ updateCustomHeaders,
+ registerHeadersCallback,
+ resetHeadersCallback,
+ verifyCallback as verifyHeadersCallback
+} from "./headers";
\ No newline at end of file
diff --git a/test/auth_spec.js b/test/auth_spec.js
new file mode 100644
index 0000000..db9b7c7
--- /dev/null
+++ b/test/auth_spec.js
@@ -0,0 +1,134 @@
+/*
+ * 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.
+ */
+import {expect} from 'chai';
+import sinon from 'sinon';
+import {
+ authCallback,
+ registerAuthCallback,
+ resetAuthCallback,
+ updateAuthHeader,
+ verifyAuthCallback
+} from '../src/utils';
+
+describe('verifyCallback', () => {
+ it('should not throw error for valid callback', () => {
+ const validCallback = sinon.stub().returns('someString');
+ expect(() => verifyAuthCallback(validCallback)).to.not.throw();
+ });
+
+ it('should throw error for non-function callback', () => {
+ const nonFunctionCallback = 'notAFunction';
+ expect(() => verifyAuthCallback(nonFunctionCallback)).to.throw('Userale auth callback must be a function');
+ });
+
+ it('should throw error for non-string callback return', () => {
+ const invalidReturnCallback = sinon.stub().returns(123);
+ expect(() => verifyAuthCallback(invalidReturnCallback)).to.throw('Userale auth callback must return a string');
+ });
+
+ it('should not throw error for valid callback with empty string return', () => {
+ const validCallback = sinon.stub().returns('');
+ expect(() => verifyAuthCallback(validCallback)).to.not.throw();
+ });
+});
+
+describe('registerAuthCallback', () => {
+ afterEach(() => {
+ resetAuthCallback();
+ });
+
+ it('should register a valid callback', () => {
+ const validCallback = sinon.stub().returns('someString');
+ expect(registerAuthCallback(validCallback)).to.be.true;
+ expect(authCallback).to.equal(validCallback);
+ });
+
+ it('should not register a non-function callback', () => {
+ const nonFunctionCallback = 'notAFunction';
+ expect(registerAuthCallback(nonFunctionCallback)).to.be.false;
+ expect(authCallback).to.be.null;
+ });
+
+ it('should not register a callback with invalid return type', () => {
+ const invalidReturnCallback = sinon.stub().returns(123);
+ expect(registerAuthCallback(invalidReturnCallback)).to.be.false;
+ expect(authCallback).to.be.null;
+ });
+
+ it('should register a callback with empty string return', () => {
+ const validCallback = sinon.stub().returns('');
+ expect(registerAuthCallback(validCallback)).to.be.true;
+ expect(authCallback).to.equal(validCallback);
+ });
+});
+
+describe('updateAuthHeader', () => {
+ let config;
+
+ beforeEach(() => {
+ // Initialize config object before each test
+ config = { authHeader: null };
+ });
+
+ afterEach(() => {
+ resetAuthCallback();
+ });
+
+ it('should update auth header when authCallback is provided', () => {
+ const validCallback = sinon.stub().returns('someString');
+ registerAuthCallback(validCallback);
+ updateAuthHeader(config, authCallback);
+ expect(config.authHeader).to.equal('someString');
+ });
+
+ it('should not update auth header when authCallback is not provided', () => {
+ updateAuthHeader(config, authCallback);
+ expect(config.authHeader).to.be.null;
+ });
+
+ it('should not update auth header when authCallback returns non-string', () => {
+ const invalidReturnCallback = sinon.stub().returns(123);
+ registerAuthCallback(invalidReturnCallback);
+ updateAuthHeader(config, authCallback);
+ expect(config.authHeader).to.be.null;
+ });
+
+ it('should update auth header with empty string return from authCallback', () => {
+ const validCallback = sinon.stub().returns('');
+ registerAuthCallback(validCallback);
+ updateAuthHeader(config, authCallback);
+ expect(config.authHeader).to.equal('');
+ });
+
+ it('should handle errors thrown during authCallback execution', () => {
+ const errorThrowingCallback = sinon.stub().throws(new Error('Callback execution failed'));
+ registerAuthCallback(errorThrowingCallback);
+ updateAuthHeader(config, authCallback);
+ expect(config.authHeader).to.be.null;
+ });
+
+ it('should not update auth header after unregistering authCallback', () => {
+ const validCallback = sinon.stub().returns('someString');
+ registerAuthCallback(validCallback);
+ updateAuthHeader(config, authCallback);
+ expect(config.authHeader).to.equal('someString');
+
+ // Unregister authCallback
+ updateAuthHeader(config, null);
+ expect(config.authHeader).to.equal('someString');
+ });
+ });
\ No newline at end of file
diff --git a/test/headers_spec.js b/test/headers_spec.js
new file mode 100644
index 0000000..a8bba1d
--- /dev/null
+++ b/test/headers_spec.js
@@ -0,0 +1,141 @@
+/*
+ * 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.
+ */
+import {expect} from 'chai';
+import sinon from 'sinon';
+import {
+ headersCallback,
+ registerHeadersCallback,
+ resetHeadersCallback,
+ updateCustomHeaders,
+ verifyHeadersCallback
+} from '../src/utils';
+
+describe('verifyCallback', () => {
+ it('should not throw error for valid callback', () => {
+ const validCallback = sinon.stub().returns({'x-api-token': 'someString', 'x-abc-def': 'someOtherString'});
+ expect(() => verifyHeadersCallback(validCallback)).to.not.throw();
+ });
+
+ it('should throw error for non-function callback', () => {
+ const nonFunctionCallback = 'notAFunction';
+ expect(() => verifyHeadersCallback(nonFunctionCallback)).to.throw('Userale headers callback must be a function');
+ });
+
+ it('should throw error for non-object callback return', () => {
+ const invalidReturnCallback = sinon.stub().returns(123);
+ expect(() => verifyHeadersCallback(invalidReturnCallback)).to.throw('Userale headers callback must return an object');
+ });
+
+ it('should throw error for incorrect headers object return', () => {
+ const invalidReturnCallback = sinon.stub().returns({'x-not-a-proper-value': 123});
+ expect(() => verifyHeadersCallback(invalidReturnCallback)).to.throw('Userale header callback must return an object with string keys and values');
+ });
+
+ it('should not throw error for valid callback with empty object return', () => {
+ const validCallback = sinon.stub().returns({});
+ expect(() => verifyHeadersCallback(validCallback)).to.not.throw();
+ });
+});
+
+describe('registerHeadersCallback', () => {
+ afterEach(() => {
+ resetHeadersCallback();
+ });
+
+ it('should register a valid callback', () => {
+ const validCallback = sinon.stub().returns({'x-api-token': 'someString', 'x-abc-def': 'someOtherString'});
+ expect(registerHeadersCallback(validCallback)).to.be.true;
+ expect(headersCallback).to.equal(validCallback);
+ });
+
+ it('should not register a non-function callback', () => {
+ const nonFunctionCallback = 'notAFunction';
+ expect(registerHeadersCallback(nonFunctionCallback)).to.be.false;
+ expect(headersCallback).to.be.null;
+ });
+
+ it('should not register a callback with invalid return type', () => {
+ const invalidReturnCallback = sinon.stub().returns(123);
+ expect(registerHeadersCallback(invalidReturnCallback)).to.be.false;
+ expect(headersCallback).to.be.null;
+ });
+
+ it('should register a callback with empty object return', () => {
+ const validCallback = sinon.stub().returns({});
+ expect(registerHeadersCallback(validCallback)).to.be.true;
+ expect(headersCallback).to.equal(validCallback);
+ });
+});
+
+describe('updateCustomHeader', () => {
+ let config;
+
+ beforeEach(() => {
+ // Initialize config object before each test
+ config = { headers: null };
+ });
+
+ afterEach(() => {
+ resetHeadersCallback();
+ });
+
+ it('should update custom headers when headersCallback is provided', () => {
+ const customHeaders = {'x-api-token': 'someString', 'x-abc-def': 'someOtherString'}
+ const validCallback = sinon.stub().returns(customHeaders);
+ registerHeadersCallback(validCallback);
+ updateCustomHeaders(config, headersCallback);
+ expect(config.headers).to.equal(customHeaders);
+ });
+
+ it('should not update custom headers when headersCallback is not provided', () => {
+ updateCustomHeaders(config, headersCallback);
+ expect(config.headers).to.be.null;
+ });
+
+ it('should not update custom headers when headersCallback returns non-object', () => {
+ const invalidReturnCallback = sinon.stub().returns(123);
+ registerHeadersCallback(invalidReturnCallback);
+ updateCustomHeaders(config, headersCallback);
+ expect(config.headers).to.be.null;
+ });
+
+ it('should update custom headers with empty string return from headersCallback', () => {
+ const validCallback = sinon.stub().returns({});
+ registerHeadersCallback(validCallback);
+ updateCustomHeaders(config, headersCallback);
+ expect(config.headers).to.deep.equal({});
+ });
+
+ it('should handle errors thrown during headersCallback execution', () => {
+ const errorThrowingCallback = sinon.stub().throws(new Error('Callback execution failed'));
+ registerHeadersCallback(errorThrowingCallback);
+ updateCustomHeaders(config, headersCallback);
+ expect(config.headers).to.be.null;
+ });
+
+ it('should not update custom headers after unregistering headersCallback', () => {
+ const customHeaders = {'x-api-token': 'someString', 'x-abc-def': 'someOtherString'}
+ const validCallback = sinon.stub().returns(customHeaders);
+ registerHeadersCallback(validCallback);
+ updateCustomHeaders(config, headersCallback);
+ expect(config.headers).to.equal(customHeaders);
+
+ // Unregister headersCallback
+ updateCustomHeaders(config, null);
+ expect(config.headers).to.equal(customHeaders);
+ });
+ });
\ No newline at end of file
diff --git a/test/main_spec.js b/test/main_spec.js
index 8f66d1e..5bc045a 100644
--- a/test/main_spec.js
+++ b/test/main_spec.js
@@ -39,6 +39,7 @@
'userFromParams',
'time',
'authHeader',
+ 'headers',
'custIndex'
]);
dom.window.close();
diff --git a/test/sendLogs_spec.js b/test/sendLogs_spec.js
index 35686e6..7b50802 100644
--- a/test/sendLogs_spec.js
+++ b/test/sendLogs_spec.js
@@ -14,12 +14,16 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-import {expect} from 'chai';
+import chai, {expect} from 'chai';
+import chaiSubset from 'chai-subset';
import {JSDOM} from 'jsdom';
import sinon from 'sinon';
-import {sendOnInterval, sendOnClose} from '../src/sendLogs';
+import {initSender, sendOnInterval, sendOnClose} from '../src/sendLogs';
+import {registerAuthCallback, registerHeadersCallback} from '../src/utils';
import 'global-jsdom/register'
+chai.use(chaiSubset);
+
describe('sendLogs', () => {
it('sends logs on an interval', (done) => {
let requests = 0;
@@ -110,4 +114,81 @@
global.window.dispatchEvent(new window.CustomEvent('pagehide'))
sinon.assert.notCalled(sendBeaconSpy)
});
+
+ it('sends logs with proper auth header when using registerAuthCallback', (done) => {
+ let requests = []
+ const originalXMLHttpRequest = global.XMLHttpRequest;
+ const conf = { on: true, transmitInterval: 500, url: 'test', logCountThreshold: 1 };
+ const logs = [];
+ const clock = sinon.useFakeTimers();
+ const xhr = sinon.useFakeXMLHttpRequest();
+ global.XMLHttpRequest = xhr;
+ xhr.onCreate = (xhr) => {
+ requests.push(xhr);
+ };
+
+ // Mock the authCallback function
+ const authCallback = sinon.stub().returns('fakeAuthToken');
+
+ // Register the authCallback
+ registerAuthCallback(authCallback);
+
+ // Initialize sender with logs and config
+ initSender(logs, conf);
+
+ // Simulate log entry
+ logs.push({ foo: 'bar' });
+
+ // Trigger interval to send logs
+ clock.tick(conf.transmitInterval);
+
+ // Verify that the request has the proper auth header
+ expect(requests.length).to.equal(1);
+ expect(requests[0].requestHeaders.Authorization).to.equal('fakeAuthToken');
+
+ // Restore XMLHttpRequest and clock
+ xhr.restore();
+ clock.restore();
+ global.XMLHttpRequest = originalXMLHttpRequest;
+ done()
+ });
+
+ it('sends logs with proper custom headers when using registerHeadersCallback', (done) => {
+ let requests = []
+ const originalXMLHttpRequest = global.XMLHttpRequest;
+ const conf = { on: true, transmitInterval: 500, url: 'test', logCountThreshold: 1 };
+ const logs = [];
+ const clock = sinon.useFakeTimers();
+ const xhr = sinon.useFakeXMLHttpRequest();
+ global.XMLHttpRequest = xhr;
+ xhr.onCreate = (xhr) => {
+ requests.push(xhr);
+ };
+
+ // Mock the authCallback function
+ const customHeaders = {'x-api-token': 'someString', 'x-abc-def': 'someOtherString'}
+ const headersCallback = sinon.stub().returns(customHeaders);
+
+ // Register the authCallback
+ registerHeadersCallback(headersCallback);
+
+ // Initialize sender with logs and config
+ initSender(logs, conf);
+
+ // Simulate log entry
+ logs.push({ foo: 'bar' });
+
+ // Trigger interval to send logs
+ clock.tick(conf.transmitInterval);
+
+ // Verify that the request has the proper auth header
+ expect(requests.length).to.equal(1);
+ expect(requests[0].requestHeaders).to.containSubset(customHeaders);
+
+ // Restore XMLHttpRequest and clock
+ xhr.restore();
+ clock.restore();
+ global.XMLHttpRequest = originalXMLHttpRequest;
+ done()
+ });
});
