@newrelic/browser-agent 0.0.9 → 0.1.230

package/src/common/util/traverse.js

@@ -0,0 +1,36 @@
+/*
+ * 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/src/common/util/user-agent.js

@@ -0,0 +1,56 @@
+/*
+ * 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/src/common/window/load.js

@@ -0,0 +1,15 @@
+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)
+}

package/src/common/window/nreum.js

@@ -0,0 +1,110 @@
+
+import { now } from '../timing/now'
+import { globalScope } from '../util/global-scope'
+
+export const defaults = {
+  beacon: 'bam.nr-data.net',
+  errorBeacon: 'bam.nr-data.net'
+}
+
+export function gosNREUM () {
+  if (!globalScope.NREUM) {
+    globalScope.NREUM = {}
+  }
+  if (typeof globalScope.newrelic === 'undefined') globalScope.newrelic = globalScope.NREUM
+  return globalScope.NREUM
+}
+
+export function gosNREUMInfo () {
+  let nr = gosNREUM()
+  const externallySupplied = nr.info || {}
+
+  nr.info = {
+    beacon: defaults.beacon,
+    errorBeacon: defaults.errorBeacon,
+    ...externallySupplied
+  }
+
+  return nr
+}
+
+export function gosNREUMLoaderConfig () {
+  let nr = gosNREUM()
+  const externallySupplied = nr.loader_config || {}
+
+  nr.loader_config = {
+    ...externallySupplied
+  }
+
+  return nr
+}
+
+export function gosNREUMInit () {
+  let nr = gosNREUM()
+  const externallySupplied = nr.init || {}
+
+  nr.init = {
+    ...externallySupplied
+  }
+
+  return nr
+}
+
+export function gosNREUMOriginals () {
+  let nr = gosNREUM()
+  if (!nr.o) {
+    nr.o = {
+      ST: globalScope.setTimeout,
+      SI: globalScope.setImmediate,
+      CT: globalScope.clearTimeout,
+      XHR: globalScope.XMLHttpRequest,
+      REQ: globalScope.Request,
+      EV: globalScope.Event,
+      PR: globalScope.Promise,
+      MO: globalScope.MutationObserver, // this'll be undefined if not in a web window
+      FETCH: globalScope.fetch
+    }
+  }
+  return nr
+}
+
+export function gosNREUMInitializedAgents (id, obj, target) {
+  let nr = gosNREUM()
+  const externallySupplied = nr.initializedAgents || {}
+  const curr = externallySupplied[id] || {}
+
+  if (!Object.keys(curr).length) {
+    curr.initializedAt = {
+      ms: now(),
+      date: new Date()
+    }
+  }
+
+  nr.initializedAgents = {
+    ...externallySupplied,
+    [id]: {
+      ...curr,
+      [target]: obj
+    }
+  }
+
+  return nr
+}
+
+export function addToNREUM (fnName, fn) {
+  let nr = gosNREUM()
+  nr[fnName] = fn
+}
+
+export function NREUMinitialized () {
+  const nr = gosNREUM()
+  nr.initialized = true
+}
+
+export function gosCDN () {
+  gosNREUMInfo()
+  gosNREUMInit()
+  gosNREUMOriginals()
+  gosNREUMLoaderConfig()
+  return gosNREUM()
+}

package/src/common/window/page-visibility.js

@@ -0,0 +1,24 @@
+/*
+ * Copyright 2020 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { documentAddEventListener } from '../event-listener/event-listener-opts'
+
+/**
+ * @param {function} cb - called when a visibility change occurs with the vis state at that time
+ * @param {boolean} [toHiddenOnly=false] - only execute the 'cb' when the vis is changing to the hidden state; no arg is passed to 'cb' if used
+ * @returns void
+ */
+export function subscribeToVisibilityChange (cb, toHiddenOnly = false) {
+  documentAddEventListener('visibilitychange', handleVisibilityChange)
+  return
+
+  function handleVisibilityChange () {
+    if (toHiddenOnly) { // trigger cb on change to hidden state only
+      if (document.visibilityState == 'hidden') cb()
+      else return
+    }
+    cb(document.visibilityState)
+  }
+}

package/src/common/window/session-storage.js

@@ -0,0 +1,75 @@
+/**
+ * Interface for Agents' usage of the Window.sessionStorage as a replacement to third-party cookies.
+ *  (All agents on a tab|window will share the same sessionStorage.)
+ *
+ * @design https://newrelic.atlassian.net/wiki/spaces/INST/pages/2522513791/JSESSIONID+Cookie+Change+Design+Document
+ * @environment Browser script
+ */
+import { generateRandomHexString } from '../ids/unique-id'
+
+const AGENT_PREFIX = 'NRBA/'
+
+/**
+ * @param {string} key
+ * @param {string} value
+ * @returns true, if item was set successfully. false, if storage is full or setItem threw an exception.
+ */
+export function putInBrowserStorage (key, value, subgroup = '') {
+  try {
+    window.sessionStorage.setItem(AGENT_PREFIX + subgroup + key, value)
+    return true
+  } catch (ex) {
+    // Session storage may be full.
+    return false
+  }
+}
+/**
+ * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Storage/getItem}
+ * @param {string} key
+ */
+function getFromBrowserStorage (key, subgroup = '') {
+  return window.sessionStorage.getItem(AGENT_PREFIX + subgroup + key)
+}
+export function removeFromBrowserStorage (key, subgroup = '') {
+  try {
+    window.sessionStorage.removeItem(AGENT_PREFIX + subgroup + key)
+  } catch (e) {}
+}
+
+/**
+ * @returns {string} This tab|window's session identifier, or a new ID if not found in storage
+ */
+export function getCurrentSessionIdOrMakeNew () {
+  try {
+    let sessionId
+    if ((sessionId = getFromBrowserStorage('SESSION_ID')) === null) {
+      // Generate a new one if storage is empty (no previous ID was created or currently exists)
+      sessionId = generateRandomHexString(16)
+      putInBrowserStorage('SESSION_ID', sessionId)
+    }
+    return sessionId
+  } catch (ex) {
+    // The agent is running in a security context that does not allow access to the sessionStorage or is not in browser window context.
+    return null
+  }
+}
+
+/**
+ * Look through the page's sessionStorage items and gather the ones that was set under some grouping label, if applicable.
+ * @param {string} [subgroup] - empty string by default, which will return all items set by browser agent
+ * @returns An object of the key-value items from putInBrowserStorage calls from agents with access to the same storage space.
+ */
+export function getAllStorageItemsOfGroup (subgroup = '') {
+  const prefixFilter = AGENT_PREFIX + subgroup
+  const groupItems = {}
+  try {
+    for (let i = 0; i < window.sessionStorage.length; i++) {
+      let key = window.sessionStorage.key(i)
+      if (!key.startsWith(prefixFilter)) continue
+      else key = key.slice(prefixFilter.length) // this removes the "NRBA/<subgroup>" prefix so we get back the original key putInBrowserStorage
+
+      groupItems[key] = getFromBrowserStorage(key, subgroup)
+    }
+  } catch (ex) { }
+  return groupItems
+}

package/src/common/window/supports-performance-observer.js

@@ -0,0 +1,10 @@
+/*
+ * Copyright 2020 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { globalScope } from '../util/global-scope'
+
+export function supportsPerformanceObserver () {
+  return (typeof globalScope?.PerformanceObserver === 'function')
+}

package/src/common/wrap/index.js

@@ -0,0 +1,18 @@
+/**
+ * @file Wraps assorted native objects and functions for instrumentation.
+ */
+
+import { wrapConsole } from './wrap-console'
+import { wrapEvents } from './wrap-events'
+import { wrapFetch } from './wrap-fetch'
+import { wrapHistory } from './wrap-history'
+import { wrapJsonP } from './wrap-jsonp'
+import { wrapMutation } from './wrap-mutation'
+import { wrapPromise } from './wrap-promise'
+import { wrapRaf } from './wrap-raf'
+import { wrapTimer } from './wrap-timer'
+import { wrapXhr } from './wrap-xhr'
+
+export {
+  wrapConsole, wrapEvents, wrapFetch, wrapHistory, wrapJsonP, wrapMutation, wrapPromise, wrapRaf, wrapTimer, wrapXhr
+}

package/src/common/wrap/wrap-console.js

@@ -0,0 +1,47 @@
+/*
+ * Copyright 2020 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * @file Wraps `debug`, `error`, `info`, `log`, `trace, and `warn` methods of the global `console` object for instrumentation.
+ * This module is used by: metrics.
+ */
+import { ee as globalEE } from '../event-emitter/contextual-ee'
+import { createWrapperWithEmitter } from './wrap-function'
+import { globalScope } from '../util/global-scope'
+
+const wrapped = {}
+const CONSOLE_METHODS = ['debug', 'error', 'info', 'log', 'trace', 'warn']
+
+/**
+ * Wraps the `debug`, `error`, `info`, `log`, `trace, and `warn` methods of global `console` object and returns a
+ * corresponding event emitter scoped to the console object.
+ * @param {Object} sharedEE - The shared event emitter on which a new scoped event emitter will be based.
+ * @returns {Object} Scoped event emitter with a debug ID of `console`.
+ */
+export function wrapConsole (sharedEE) {
+  const ee = scopedEE(sharedEE)
+
+  // We want to wrap console once and only once for each agent instance (`ee.debugId`).
+  if (wrapped[ee.debugId]) { return ee }
+  wrapped[ee.debugId] = true
+
+  var functionWrapper = createWrapperWithEmitter(ee)
+  // Because the console object exists once on the global scope, we don't need to wrap the prototype's methods.
+  // We use the global scope instead of window to accomodate service workers.
+  // The leading hyphen on '-console-' tells `inPlace` to prefix emitted event names with the method name too.
+  functionWrapper.inPlace(globalScope.console, CONSOLE_METHODS, '-console-')
+
+  return ee
+}
+
+/**
+ * Returns an event emitter scoped specifically for the `console` context. This scoping is a remnant from when all the
+ * features shared the same group in the event, to isolate events between features. It will likely be revisited.
+ * @param {Object} sharedEE - Optional event emitter on which to base the scoped emitter.
+ *    Uses `ee` on the global scope if undefined).
+ * @returns {Object} Scoped event emitter with a debug ID of 'console'.
+ */
+export function scopedEE (sharedEE) {
+  return (sharedEE || globalEE).get('console')
+}

package/src/common/wrap/wrap-events.js

@@ -0,0 +1,106 @@
+/*
+ * Copyright 2020 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * @file Wraps `addEventListener` and `removeEventListener` for instrumentation.
+ * This module is used directly by: session_trace.
+ * It is also called by -> wrapXhr <-, so see "wrap-xhr.js" for features that use this indirectly.
+ */
+import { ee as baseEE } from '../event-emitter/contextual-ee'
+import { createWrapperWithEmitter as wfn } from './wrap-function'
+import { getOrSet } from '../util/get-or-set'
+import { globalScope, isBrowserScope } from '../util/global-scope'
+
+const wrapped = {}
+const XHR = XMLHttpRequest
+const ADD_EVENT_LISTENER = 'addEventListener'
+const REMOVE_EVENT_LISTENER = 'removeEventListener'
+
+/**
+ * Wraps `addEventListener` and `removeEventListener` on: global scope; the prototype of `XMLHttpRequest`, and
+ * `document` (if in a browser scope). Adds custom events in context of a new emitter scoped only to these methods.
+ * @param {Object} sharedEE - The shared event emitter on which a new scoped
+ *     event emitter will be based.
+ * @returns {Object} Scoped event emitter with a debug ID of `events`.
+ */
+export function wrapEvents (sharedEE) {
+  var ee = scopedEE(sharedEE)
+  if (wrapped[ee.debugId]++) // Notice if our wrapping never ran yet, the falsey NaN will not early return; but if it has,
+  { return ee } // then we increment the count to track # of feats using this at runtime.
+  wrapped[ee.debugId] = 1
+
+  var wrapFn = wfn(ee, true)
+
+  // Guard against instrumenting environments w/o necessary features
+  if ('getPrototypeOf' in Object) {
+    if (isBrowserScope)
+    { findEventListenerProtoAndCb(document, wrapNode) }
+    findEventListenerProtoAndCb(globalScope, wrapNode)
+    findEventListenerProtoAndCb(XHR.prototype, wrapNode)
+  }
+
+  ee.on(ADD_EVENT_LISTENER + '-start', function (args, target) {
+    var originalListener = args[1]
+    if (originalListener === null ||
+      (typeof originalListener !== 'function' && typeof originalListener !== 'object')
+    ) {
+      return
+    }
+
+    var wrapped = getOrSet(originalListener, 'nr@wrapped', function () {
+      var listener = {
+        object: wrapHandleEvent,
+        function: originalListener
+      }[typeof originalListener]
+
+      return listener ? wrapFn(listener, 'fn-', null, (listener.name || 'anonymous')) : originalListener
+
+      function wrapHandleEvent () {
+        if (typeof originalListener.handleEvent !== 'function') return
+        return originalListener.handleEvent.apply(originalListener, arguments)
+      }
+    })
+
+    this.wrapped = args[1] = wrapped
+  })
+
+  ee.on(REMOVE_EVENT_LISTENER + '-start', function (args) {
+    args[1] = this.wrapped || args[1]
+  })
+
+  function wrapNode (node) {
+    wrapFn.inPlace(node, [ADD_EVENT_LISTENER, REMOVE_EVENT_LISTENER], '-', uniqueListener)
+  }
+
+  function uniqueListener (args, obj) {
+    // Context for the listener is stored on itself.
+    return args[1]
+  }
+
+  return ee
+}
+/**
+ * Find the base prototype of 'object' that has its own "addEventListener" property, and run some function on it.
+ * @param {Object} object - the initial object to traverse prototype chain on
+ * @param {Function} cb - the function to run on the ancestral object once found, accepts an object as a arg
+ * @param {Array} rest - [optional] any additional arguments to pass to the cb
+ */
+function findEventListenerProtoAndCb (object, cb, ...rest) {
+  let step = object
+  while (typeof step === 'object' && !Object.prototype.hasOwnProperty.call(step, ADD_EVENT_LISTENER)) {
+    step = Object.getPrototypeOf(step)
+  }
+  if (step) cb(step, ...rest)
+}
+
+/**
+ * Returns an event emitter scoped specifically for the `events` context. This scoping is a remnant from when all the
+ * features shared the same group in the event, to isolate events between features. It will likely be revisited.
+ * @param {Object} sharedEE - Optional event emitter on which to base the scoped emitter.
+ *     Uses `ee` on the global scope if undefined).
+ * @returns {Object} Scoped event emitter with a debug ID of 'events'.
+ */
+export function scopedEE (sharedEE) {
+  return (sharedEE || baseEE).get('events')
+}

package/src/common/wrap/wrap-fetch.js

@@ -0,0 +1,109 @@
+/*
+ * Copyright 2020 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * @file Wraps `fetch` and related methods for instrumentation.
+ * This module is used by: ajax, spa.
+ */
+import { ee as baseEE } from '../event-emitter/contextual-ee'
+import slice from 'lodash._slice'
+import { globalScope } from '../util/global-scope'
+import { flag } from './wrap-function'
+
+var prefix = 'fetch-'
+var bodyPrefix = prefix + 'body-'
+var bodyMethods = ['arrayBuffer', 'blob', 'json', 'text', 'formData']
+var Req = globalScope.Request
+var Res = globalScope.Response
+var proto = 'prototype'
+var ctxId = 'nr@context'
+
+const wrapped = {}
+
+/**
+ * Wraps the `fetch` method of the global scope for instrumentation. Also wraps the prototypes of the async methods
+ * that parse Request and Response bodies to generate start and end events for each, in context of a new event
+ * emitter scoped only to fetch and related methods.
+ * @param {Object} sharedEE - The shared event emitter on which a new scoped
+ *     event emitter will be based.
+ * @returns {Object} Scoped event emitter with a debug ID of `fetch`.
+ */
+export function wrapFetch (sharedEE) {
+  const ee = scopedEE(sharedEE)
+  if (!(Req && Res && globalScope.fetch)) {
+    return ee
+  }
+
+  if (wrapped[ee.debugId]++) // Notice if our wrapping never ran yet, the falsey NaN will not early return; but if it has,
+  { return ee } // then we increment the count to track # of feats using this at runtime.
+  wrapped[ee.debugId] = 1
+
+  bodyMethods.forEach(method => {
+    wrapPromiseMethod(Req[proto], method, bodyPrefix)
+    wrapPromiseMethod(Res[proto], method, bodyPrefix)
+  })
+  wrapPromiseMethod(globalScope, 'fetch', prefix)
+
+  ee.on(prefix + 'end', function (err, res) {
+    var ctx = this
+    if (res) {
+      var size = res.headers.get('content-length')
+      if (size !== null) {
+        ctx.rxSize = size
+      }
+      ee.emit(prefix + 'done', [null, res], ctx)
+    } else {
+      ee.emit(prefix + 'done', [err], ctx)
+    }
+  })
+
+  /**
+   * Wraps a Promise-returning function (referenced by `target[name]`) to emit custom events before and after
+   * execution, each decorated with metadata (arguments, payloads, errors). Used to wrap the async body
+   * parsing methods of Request and Response (e.g. `json`, `text`, `formData`).
+   * @param {Object} target - The object having the method to be wrapped.
+   * @param {string} name - The name of the method to wrap.
+   * @param {string} prefix - Used to decorate event names with context.
+   */
+  function wrapPromiseMethod (target, name, prefix) {
+    var fn = target[name]
+    if (typeof fn === 'function') {
+      target[name] = function () {
+        var args = slice(arguments)
+
+        var ctx = {}
+        // we are wrapping args in an array so we can preserve the reference
+        ee.emit(prefix + 'before-start', [args], ctx)
+        var dtPayload
+        if (ctx[ctxId] && ctx[ctxId].dt) dtPayload = ctx[ctxId].dt
+
+        var origPromiseFromFetch = fn.apply(this, args)
+
+        ee.emit(prefix + 'start', [args, dtPayload], origPromiseFromFetch)
+
+        // Note we need to cast the returned (orig) Promise from native APIs into the current global Promise, which may or may not be our WrappedPromise.
+        return origPromiseFromFetch.then(function (val) {
+          ee.emit(prefix + 'end', [null, val], origPromiseFromFetch)
+          return val
+        }, function (err) {
+          ee.emit(prefix + 'end', [err], origPromiseFromFetch)
+          throw err
+        })
+      }
+    }
+  }
+
+  return ee
+}
+
+/**
+ * Returns an event emitter scoped specifically for the `fetch` context. This scoping is a remnant from when all the
+ * features shared the same group in the event, to isolate events between features. It will likely be revisited.
+ * @param {Object} sharedEE - Optional event emitter on which to base the scoped emitter.
+ *     Uses `ee` on the global scope if undefined).
+ * @returns {Object} Scoped event emitter with a debug ID of 'fetch'.
+ */
+export function scopedEE (sharedEE) {
+  return (sharedEE || baseEE).get('fetch')
+}