@newrelic/browser-agent 0.0.9 → 0.1.229

package/dist/esm/common/url/encode.js

@@ -0,0 +1,71 @@
+/*
+ * Copyright 2020 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { mapOwn } from '../util/map-own';
+import { stringify } from '../util/stringify';
+
+// Characters that are safe in a qs, but get encoded.
+var charMap = {
+  '%2C': ',',
+  '%3A': ':',
+  '%2F': '/',
+  '%40': '@',
+  '%24': '$',
+  '%3B': ';'
+};
+var charList = mapOwn(charMap, function (k) {
+  return k;
+});
+var safeEncoded = new RegExp(charList.join('|'), 'g');
+function real(c) {
+  return charMap[c];
+}
+
+// Encode as URI Component, then unescape anything that is ok in the
+// query string position.
+export function qs(value) {
+  if (value === null || value === undefined) return 'null';
+  return encodeURIComponent(value).replace(safeEncoded, real);
+}
+export function fromArray(qs, maxBytes) {
+  var bytes = 0;
+  for (var i = 0; i < qs.length; i++) {
+    bytes += qs[i].length;
+    if (bytes > maxBytes) return qs.slice(0, i).join('');
+  }
+  return qs.join('');
+}
+export function obj(payload, maxBytes) {
+  var total = 0;
+  var result = '';
+  mapOwn(payload, function (feature, dataArray) {
+    var intermediate = [];
+    var next;
+    var i;
+    if (typeof dataArray === 'string') {
+      next = '&' + feature + '=' + qs(dataArray);
+      total += next.length;
+      result += next;
+    } else if (dataArray.length) {
+      total += 9;
+      for (i = 0; i < dataArray.length; i++) {
+        next = qs(stringify(dataArray[i]));
+        total += next.length;
+        if (typeof maxBytes !== 'undefined' && total >= maxBytes) break;
+        intermediate.push(next);
+      }
+      result += '&' + feature + '=%5B' + intermediate.join(',') + '%5D';
+    }
+  });
+  return result;
+}
+
+// Constructs an HTTP parameter to add to the BAM router URL
+export function param(name, value) {
+  if (value && typeof value === 'string') {
+    return '&' + name + '=' + qs(value);
+  }
+  return '';
+}

package/dist/esm/common/url/location.js

@@ -0,0 +1,8 @@
+/*
+ * Copyright 2020 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+export function getLocation() {
+  return '' + location;
+}

package/dist/esm/common/url/parse-url.js

@@ -0,0 +1,60 @@
+/*
+ * Copyright 2020 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { globalScope, isBrowserScope } from '../util/global-scope';
+var stringsToParsedUrls = {};
+export function parseUrl(url) {
+  if (url in stringsToParsedUrls) {
+    return stringsToParsedUrls[url];
+  }
+
+  // Return if URL is a data URL, parseUrl assumes urls are http/https
+  if ((url || '').indexOf('data:') === 0) {
+    return {
+      protocol: 'data'
+    };
+  }
+  let urlEl;
+  var location = globalScope?.location;
+  var ret = {};
+  if (isBrowserScope) {
+    // Use an anchor dom element to resolve the url natively.
+    urlEl = document.createElement('a');
+    urlEl.href = url;
+  } else {
+    try {
+      urlEl = new URL(url, location.href);
+    } catch (err) {
+      return ret;
+    }
+  }
+  ret.port = urlEl.port;
+  var firstSplit = urlEl.href.split('://');
+  if (!ret.port && firstSplit[1]) {
+    ret.port = firstSplit[1].split('/')[0].split('@').pop().split(':')[1];
+  }
+  if (!ret.port || ret.port === '0') ret.port = firstSplit[0] === 'https' ? '443' : '80';
+
+  // Host not provided in IE for relative urls
+  ret.hostname = urlEl.hostname || location.hostname;
+  ret.pathname = urlEl.pathname;
+  ret.protocol = firstSplit[0];
+
+  // Pathname sometimes doesn't have leading slash (IE 8 and 9)
+  if (ret.pathname.charAt(0) !== '/') ret.pathname = '/' + ret.pathname;
+
+  // urlEl.protocol is ':' in old ie when protocol is not specified
+  var sameProtocol = !urlEl.protocol || urlEl.protocol === ':' || urlEl.protocol === location.protocol;
+  var sameDomain = urlEl.hostname === location.hostname && urlEl.port === location.port;
+
+  // urlEl.hostname is not provided by IE for relative urls, but relative urls are also same-origin
+  ret.sameOrigin = sameProtocol && (!urlEl.hostname || sameDomain);
+
+  // Only cache if url doesn't have a path
+  if (ret.pathname === '/') {
+    stringsToParsedUrls[url] = ret;
+  }
+  return ret;
+}

package/dist/esm/common/url/protocol.js

@@ -0,0 +1,17 @@
+/*
+ * Copyright 2020 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { getGlobalScope } from '../util/global-scope';
+export const protocol = {
+  isFileProtocol: isFileProtocol,
+  supportabilityMetricSent: false
+};
+function isFileProtocol() {
+  let isFile = Boolean(getGlobalScope()?.location?.protocol === 'file:');
+  if (isFile) {
+    //metrics.recordSupportability('Generic/FileProtocol/Detected') -- may be implemented later? Probably make sure it's once per window
+    protocol.supportabilityMetricSent = true;
+  }
+  return isFile;
+}

package/dist/esm/common/util/console.js

@@ -0,0 +1,11 @@
+/**
+ * A helper method to warn to the console with New Relic: decoration
+ * @param {string} message - The primary message to warn
+ * @param {*} secondary - Secondary data to include, usually an error or object
+ * @returns
+ */
+export function warn(message, secondary) {
+  if (!console || !console.warn || typeof console.warn !== 'function') return;
+  console.warn(`New Relic: ${message}`);
+  if (secondary) console.warn(secondary);
+}

package/dist/esm/common/util/data-size.js

@@ -0,0 +1,19 @@
+/*
+ * Copyright 2020 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { stringify } from './stringify';
+export function dataSize(data) {
+  if (typeof data === 'string' && data.length) return data.length;
+  if (typeof data !== 'object') return undefined;
+  // eslint-disable-next-line
+  if (typeof ArrayBuffer !== 'undefined' && data instanceof ArrayBuffer && data.byteLength) return data.byteLength;
+  if (typeof Blob !== 'undefined' && data instanceof Blob && data.size) return data.size;
+  if (typeof FormData !== 'undefined' && data instanceof FormData) return undefined;
+  try {
+    return stringify(data).length;
+  } catch (e) {
+    return undefined;
+  }
+}

package/dist/esm/common/util/feature-flags.js

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2020 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { mapOwn } from './map-own';
+import { ee } from '../event-emitter/contextual-ee';
+import { handle } from '../event-emitter/handle';
+import { drain } from '../drain/drain';
+import { FEATURE_NAMES } from '../../loaders/features/features';
+const bucketMap = {
+  stn: [FEATURE_NAMES.sessionTrace],
+  err: [FEATURE_NAMES.jserrors, FEATURE_NAMES.metrics],
+  ins: [FEATURE_NAMES.pageAction],
+  spa: [FEATURE_NAMES.spa]
+};
+export function activateFeatures(flags, agentIdentifier) {
+  var sharedEE = ee.get(agentIdentifier);
+  if (!(flags && typeof flags === 'object')) return;
+  mapOwn(flags, function (flag, val) {
+    if (!val) {
+      return (bucketMap[flag] || []).forEach(feat => {
+        handle('block-' + flag, [], undefined, feat, sharedEE);
+      });
+    }
+    if (activatedFeatures[flag]) {
+      return;
+    }
+    handle('feat-' + flag, [], undefined, bucketMap[flag], sharedEE);
+    activatedFeatures[flag] = true;
+  });
+  drain(agentIdentifier, FEATURE_NAMES.pageViewEvent);
+}
+export const activatedFeatures = {};

package/dist/esm/common/util/get-or-set.js

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2020 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+var has = Object.prototype.hasOwnProperty;
+
+// Always returns the current value of obj[prop], even if it has to set it first
+export function getOrSet(obj, prop, getVal) {
+  // If the value exists return it.
+  if (has.call(obj, prop)) return obj[prop];
+  var val = getVal();
+
+  // Attempt to set the property so it's not enumerable
+  if (Object.defineProperty && Object.keys) {
+    try {
+      Object.defineProperty(obj, prop, {
+        value: val,
+        // old IE inherits non-write-ability
+        writable: true,
+        enumerable: false
+      });
+      return val;
+    } catch (e) {
+      // Can't report internal errors,
+      // because GOS is a dependency of the reporting mechanisms
+    }
+  }
+
+  // fall back to setting normally
+  obj[prop] = val;
+  return val;
+}

package/dist/esm/common/util/global-scope.js

@@ -0,0 +1,44 @@
+/* global globalThis, WorkerGlobalScope, WorkerNavigator */
+
+export const isBrowserScope = Boolean(typeof window !== 'undefined' && window.document);
+export const isWorkerScope = Boolean(typeof WorkerGlobalScope !== 'undefined' && self.navigator instanceof WorkerNavigator);
+export let globalScope = (() => {
+  if (isBrowserScope) {
+    return window;
+  } else if (isWorkerScope) {
+    if (typeof globalThis !== 'undefined' && globalThis instanceof WorkerGlobalScope) {
+      return globalThis;
+    } else if (self instanceof WorkerGlobalScope) {
+      return self;
+    }
+  }
+  throw new Error('New Relic browser agent shutting down due to error: Unable to locate global scope. This is possibly due to code redefining browser global variables like "self" and "window".');
+})();
+
+/**
+ * The below methods are only used for testing and should be removed once the
+ * reliant tests are moved to Jest.
+ * tests/browser/protocol.browser.js
+ * tests/browser/obfuscate.browser.js
+ */
+export function setScope(obj) {
+  globalScope = {
+    ...obj
+  };
+}
+export function resetScope() {
+  if (isBrowserScope) {
+    globalScope = window;
+  } else if (isWorkerScope) {
+    if (typeof globalThis !== 'undefined' && globalThis instanceof WorkerGlobalScope) {
+      globalScope = globalThis;
+    } else if (self instanceof WorkerGlobalScope) {
+      globalScope = self;
+    }
+  } else {
+    throw new Error('New Relic browser agent shutting down due to error: Unable to locate global scope. This is possibly due to code redefining browser global variables like "self" and "window".');
+  }
+}
+export function getGlobalScope() {
+  return globalScope;
+}

package/dist/esm/common/util/map-own.js

@@ -0,0 +1,18 @@
+/*
+ * Copyright 2020 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+var has = Object.prototype.hasOwnProperty;
+export function mapOwn(obj, fn) {
+  var results = [];
+  var key = '';
+  var i = 0;
+  for (key in obj) {
+    if (has.call(obj, key)) {
+      results[i] = fn(key, obj[key]);
+      i += 1;
+    }
+  }
+  return results;
+}

package/dist/esm/common/util/obfuscate.js

@@ -0,0 +1,67 @@
+import { getConfigurationValue } from '../config/config';
+import { SharedContext } from '../context/shared-context';
+import { protocol } from '../url/protocol';
+import { warn } from './console';
+var fileProtocolRule = {
+  regex: /^file:\/\/(.*)/,
+  replacement: 'file://OBFUSCATED'
+};
+export class Obfuscator extends SharedContext {
+  constructor(parent) {
+    super(parent); // gets any allowed properties from the parent and stores them in `sharedContext`
+  }
+
+  shouldObfuscate() {
+    return getRules(this.sharedContext.agentIdentifier).length > 0;
+  }
+
+  // applies all regex obfuscation rules to provided URL string and returns the result
+  obfuscateString(string) {
+    // if string is empty string, null or not a string, return unmodified
+    if (!string || typeof string !== 'string') return string;
+    var rules = getRules(this.sharedContext.agentIdentifier);
+    var obfuscated = string;
+
+    // apply every rule to URL string
+    for (var i = 0; i < rules.length; i++) {
+      var regex = rules[i].regex;
+      var replacement = rules[i].replacement || '*';
+      obfuscated = obfuscated.replace(regex, replacement);
+    }
+    return obfuscated;
+  }
+}
+
+// TO DO: this function should be inside the Obfuscator class since its context relates to agentID
+export function getRules(agentIdentifier) {
+  var rules = [];
+  var configRules = getConfigurationValue(agentIdentifier, 'obfuscate') || [];
+  rules = rules.concat(configRules);
+  if (protocol.isFileProtocol()) rules.push(fileProtocolRule);
+  // could add additional runtime/environment-specific rules here
+
+  return rules;
+}
+
+// takes array of rule objects, logs warning and returns false if any portion of rule is invalid
+export function validateRules(rules) {
+  var invalidReplacementDetected = false;
+  var invalidRegexDetected = false;
+  for (var i = 0; i < rules.length; i++) {
+    if (!('regex' in rules[i])) {
+      warn('An obfuscation replacement rule was detected missing a "regex" value.');
+      invalidRegexDetected = true;
+    } else if (typeof rules[i].regex !== 'string' && !(rules[i].regex.constructor === RegExp)) {
+      warn('An obfuscation replacement rule contains a "regex" value with an invalid type (must be a string or RegExp)');
+      invalidRegexDetected = true;
+    }
+    var replacement = rules[i].replacement;
+    if (replacement) {
+      if (typeof replacement !== 'string') {
+        warn('An obfuscation replacement rule contains a "replacement" value with an invalid type (must be a string)');
+        invalidReplacementDetected = true;
+      }
+    }
+  }
+  return !invalidReplacementDetected && !invalidRegexDetected;
+}

package/dist/esm/common/util/reduce.js

@@ -0,0 +1,16 @@
+/*
+ * Copyright 2020 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+export function reduce(arr, fn, next) {
+  var i = 0;
+  if (typeof next === 'undefined') {
+    next = arr[0];
+    i = 1;
+  }
+  for (i; i < arr.length; i++) {
+    next = fn(next, arr[i]);
+  }
+  return next;
+}

package/dist/esm/common/util/s-hash.js

@@ -0,0 +1,13 @@
+/*
+ * Copyright 2020 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+export function sHash(s) {
+  var i;
+  var h = 0;
+  for (i = 0; i < s.length; i++) {
+    h += (i + 1) * s.charCodeAt(i);
+  }
+  return Math.abs(h);
+}

package/dist/esm/common/util/single.js

@@ -0,0 +1,16 @@
+/*
+ * Copyright 2020 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import slice from 'lodash._slice';
+export function single(fn) {
+  var called = false;
+  var res;
+  return function () {
+    if (called) return res;
+    called = true;
+    res = fn.apply(this, slice(arguments));
+    return res;
+  };
+}

package/dist/esm/common/util/stringify.js

@@ -0,0 +1,42 @@
+/*
+ * Copyright 2020 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { ee } from '../event-emitter/contextual-ee';
+
+/**
+ * Returns a function for use as a replacer parameter in JSON.stringify() to handle circular references.
+ * @see {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Errors/Cyclic_object_value MDN - Cyclical object value}
+ * @returns {Function} A function that filters out values it has seen before.
+ */
+const getCircularReplacer = () => {
+  const seen = new WeakSet();
+  return (key, value) => {
+    if (typeof value === 'object' && value !== null) {
+      if (seen.has(value)) {
+        return;
+      }
+      seen.add(value);
+    }
+    return value;
+  };
+};
+
+/**
+ * The native JSON.stringify method augmented with a replacer function to handle circular references.
+ * Circular references will be excluded from the JSON output rather than triggering errors.
+ * @param {*} val - A value to be converted to a JSON string.
+ * @returns {string} A JSON string representation of the value, with circular references handled.
+ */
+export function stringify(val) {
+  try {
+    return JSON.stringify(val, getCircularReplacer());
+  } catch (e) {
+    try {
+      ee.emit('internal-error', [e]);
+    } catch (err) {
+      // do nothing
+    }
+  }
+}

package/dist/esm/common/util/submit-data.js

@@ -0,0 +1,91 @@
+/*
+ * Copyright 2020 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { isWorkerScope } from './global-scope';
+export const submitData = {};
+
+/**
+ * Send via JSONP. Do NOT call this function outside of a guaranteed web window environment.
+ * @param {string} url
+ * @param {string} jsonp
+ * @returns {Element}
+ */
+submitData.jsonp = function jsonp(url, jsonp) {
+  try {
+    if (isWorkerScope) {
+      try {
+        return importScripts(url + '&jsonp=' + jsonp);
+      } catch (e) {
+        // for now theres no other way to execute the callback from ingest without jsonp, or unsafe eval / new Function calls
+        // future work needs to be conducted to allow ingest to return a more traditional JSON API-like experience for the entitlement flags
+        submitData.xhrGet(url + '&jsonp=' + jsonp);
+        return false;
+      }
+    } else {
+      var element = document.createElement('script');
+      element.type = 'text/javascript';
+      element.src = url + '&jsonp=' + jsonp;
+      var firstScript = document.getElementsByTagName('script')[0];
+      firstScript.parentNode.insertBefore(element, firstScript);
+      return element;
+    }
+  } catch (err) {
+    // do nothing
+  }
+};
+submitData.xhrGet = function xhrGet(url) {
+  return submitData.xhr(url, undefined, false, 'GET');
+};
+
+/**
+ * Send via XHR
+ * @param {string} url
+ * @param {string} body
+ * @param {boolean} sync
+ * @returns {XMLHttpRequest}
+ */
+submitData.xhr = function xhr(url, body, sync, method = 'POST') {
+  var request = new XMLHttpRequest();
+  request.open(method, url, !sync);
+  try {
+    // Set cookie
+    if ('withCredentials' in request) request.withCredentials = true;
+  } catch (e) {
+    // do nothing
+  }
+  request.setRequestHeader('content-type', 'text/plain');
+  request.send(body);
+  return request;
+};
+
+/**
+ * Unused at the moment -- DEPRECATED
+ */
+// submitData.xhrSync = function xhrSync (url, body) {
+//   return submitData.xhr(url, body, true)
+// }
+
+/**
+ * Send by appending an <img> element to the page. Do NOT call this function outside of a guaranteed web window environment.
+ * @param {string} url
+ * @returns {Element}
+ */
+submitData.img = function img(url) {
+  var element = new Image();
+  element.src = url;
+  return element;
+};
+
+/**
+ * Send via sendBeacon. Do NOT call this function outside of a guaranteed web window environment.
+ * @param {string} url
+ * @param {string} body
+ * @returns {boolean}
+ */
+submitData.beacon = function (url, body) {
+  // Navigator has to be bound to ensure it does not error in some browsers
+  // https://xgwang.me/posts/you-may-not-know-beacon/#it-may-throw-error%2C-be-sure-to-catch
+  const send = window.navigator.sendBeacon.bind(navigator);
+  return send(url, body);
+};

package/dist/esm/common/util/traverse.js

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2020 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+// traverses an object and applies a fn to property values of a certain type
+export function applyFnToProps(obj, fn, type, ignoreKeys) {
+  if (!obj || typeof obj !== 'object') return obj;
+  type = type || 'string';
+  ignoreKeys = ignoreKeys || [];
+  return traverse(obj);
+  function traverse(obj) {
+    for (var property in obj) {
+      // eslint-disable-next-line
+      if (obj.hasOwnProperty(property)) {
+        if (typeof obj[property] === 'object') {
+          traverse(obj[property]);
+        } else {
+          if (typeof obj[property] === type && !shouldIgnore(property)) obj[property] = fn(obj[property]);
+        }
+      }
+    }
+    return obj;
+  }
+  function shouldIgnore(key) {
+    var ignore = false;
+    for (var i = 0; i < ignoreKeys.length; i++) {
+      if (ignoreKeys[i] === key) {
+        ignore = true;
+        break;
+      }
+    }
+    return ignore;
+  }
+}

package/dist/esm/common/util/user-agent.js

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2020 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+// Feature-detection is much preferred over using User Agent to detect browser.
+// However, there are cases where feature detection is not possible, for example
+// when a specific version of a browser has a bug that requires a workaround in just
+// that version.
+// https://developer.mozilla.org/en-US/docs/Web/HTTP/Browser_detection_using_the_user_agent#Browser_Name
+var agentName = null;
+var agentVersion = null;
+const safari = /Version\/(\S+)\s+Safari/;
+if (navigator.userAgent) {
+  var userAgent = navigator.userAgent;
+  var parts = userAgent.match(safari);
+  if (parts && userAgent.indexOf('Chrome') === -1 && userAgent.indexOf('Chromium') === -1) {
+    agentName = 'Safari';
+    agentVersion = parts[1];
+  }
+}
+export { agentName as agent, agentVersion as version };
+export function match(name, version) {
+  if (!agentName) {
+    return false;
+  }
+  if (name !== agentName) {
+    return false;
+  }
+
+  // version not provided, only match by name
+  if (!version) {
+    return true;
+  }
+
+  // version provided, but not detected - not reliable match
+  if (!agentVersion) {
+    return false;
+  }
+  var detectedParts = agentVersion.split('.');
+  var requestedParts = version.split('.');
+  for (var i = 0; i < requestedParts.length; i++) {
+    if (requestedParts[i] !== detectedParts[i]) {
+      return false;
+    }
+  }
+  return true;
+}

package/dist/esm/common/window/load.js

@@ -0,0 +1,12 @@
+import { windowAddEventListener, documentAddEventListener } from '../event-listener/event-listener-opts';
+function checkState() {
+  return typeof document === 'undefined' || document.readyState === 'complete';
+}
+export function onWindowLoad(cb, useCapture) {
+  if (checkState()) return cb();
+  windowAddEventListener('load', cb, useCapture);
+}
+export function onDOMContentLoaded(cb) {
+  if (checkState()) return cb();
+  documentAddEventListener('DOMContentLoaded', cb);
+}