@newrelic/browser-agent 1.236.0 → 1.237.0

package/src/features/utils/instrument-base.test.js

@@ -31,6 +31,13 @@ jest.mock('../../common/config/config', () => ({
   __esModule: true,
   getConfigurationValue: jest.fn()
 }))
+jest.mock('../../common/config/config', () => ({
+  __esModule: true,
+  getConfigurationValue: jest.fn(),
+  originals: {
+    MO: jest.fn()
+  }
+}))
 jest.mock('./feature-base', () => ({
   __esModule: true,
   FeatureBase: jest.fn(function (...args) {

package/src/loaders/agent-base.js

@@ -0,0 +1,81 @@
+import { warn } from '../common/util/console'
+
+export class AgentBase {
+  /**
+   * Reports a browser PageAction event along with a name and optional attributes.
+   * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/addpageaction/}
+   * @param {string} name Name or category of the action. Reported as the actionName attribute.
+   * @param {object} [attributes] JSON object with one or more key/value pairs. For example: {key:"value"}. The key is reported as its own PageAction attribute with the specified values.
+   */
+  addPageAction (name, attributes) {
+    warn('Call to agent api addPageAction failed. The session trace feature is not currently initialized.')
+  }
+
+  /**
+   * Groups page views to help URL structure or to capture the URL's routing information.
+   * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/setpageviewname/}
+   * @param {string} name The page name you want to use. Use alphanumeric characters.
+   * @param {string} [host] Default is http://custom.transaction. Typically set host to your site's domain URI.
+   */
+  setPageViewName (name, host) {
+    warn('Call to agent api setPageViewName failed. The page view feature is not currently initialized.')
+  }
+
+  /**
+   * Adds a user-defined attribute name and value to subsequent events on the page.
+   * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/setcustomattribute/}
+   * @param {string} name Name of the attribute. Appears as column in the PageView event. It will also appear as a column in the PageAction event if you are using it.
+   * @param {string|number|null} value Value of the attribute. Appears as the value in the named attribute column in the PageView event. It will appear as a column in the PageAction event if you are using it. Custom attribute values cannot be complex objects, only simple types such as Strings and Integers.
+   * @param {boolean} [persist] Default false. f set to true, the name-value pair will also be set into the browser's storage API. Then on the following instrumented pages that load within the same session, the pair will be re-applied as a custom attribute.
+   */
+  setCustomAttribute (name, value, persist) {
+    warn('Call to agent api setCustomAttribute failed. The js errors feature is not currently initialized.')
+  }
+
+  /**
+   * Identifies a browser error without disrupting your app's operations.
+   * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/noticeerror/}
+   * @param {Error|string} error Provide a meaningful error message that you can use when analyzing data on browser's JavaScript errors page.
+   * @param {object} [customAttributes] An object containing name/value pairs representing custom attributes.
+   */
+  noticeError (error, customAttributes) {
+    warn('Call to agent api noticeError failed. The js errors feature is not currently initialized.')
+  }
+
+  /**
+   * Adds a user-defined identifier string to subsequent events on the page.
+   * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/setuserid/}
+   * @param {string|null} value A string identifier for the end-user, useful for tying all browser events to specific users. The value parameter does not have to be unique. If IDs should be unique, the caller is responsible for that validation. Passing a null value unsets any existing user ID.
+   */
+  setUserId (value) {
+    warn('Call to agent api setUserId failed. The js errors feature is not currently initialized.')
+  }
+
+  /**
+   * Allows selective ignoring and grouping of known errors that the browser agent captures.
+   * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/seterrorhandler/}
+   * @param {(error: Error|string) => boolean | { group: string }} callback When an error occurs, the callback is called with the error object as a parameter. The callback will be called with each error, so it is not specific to one error.
+   */
+  setErrorHandler (callback) {
+    warn('Call to agent api setErrorHandler failed. The js errors feature is not currently initialized.')
+  }
+
+  /**
+   * Records an additional time point as "finished" in a session trace, and sends the event to New Relic.
+   * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/finished/}
+   * @param {number} [timeStamp] Defaults to the current time of the call. If used, this marks the time that the page is "finished" according to your own criteria.
+   */
+  finished (timeStamp) {
+    warn('Call to agent api finished failed. The page action feature is not currently initialized.')
+  }
+
+  /**
+   * Adds a unique name and ID to identify releases with multiple JavaScript bundles on the same page.
+   * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/addrelease/}
+   * @param {string} name A short description of the component; for example, the name of a project, application, file, or library.
+   * @param {string} id The ID or version of this release; for example, a version number, build number from your CI environment, GitHub SHA, GUID, or a hash of the contents.
+   */
+  addRelease (name, id) {
+    warn('Call to agent api addRelease failed. The agent is not currently initialized.')
+  }
+}

package/src/loaders/agent.js

@@ -1,4 +1,5 @@
 // loader files
+import { AgentBase } from './agent-base'
 import { getEnabledFeatures } from './features/enabled-features'
 import { configure } from './configure/configure'
 import { getFeatureDependencyNames } from './features/featureDependencies'
@@ -14,12 +15,18 @@ import { warn } from '../common/util/console'
 import { stringify } from '../common/util/stringify'
 import { globalScope } from '../common/constants/runtime'
 
+/**
+ * @typedef {import('./api/interaction-types').InteractionInstance} InteractionInstance
+ */
+
 /**
  * A flexible class that may be used to compose an agent from a select subset of feature modules. In applications
  * sensitive to network load, this may result in smaller builds with slightly lower performance impact.
  */
-export class Agent {
+export class Agent extends AgentBase {
   constructor (options, agentIdentifier = generateRandomHexString(16)) {
+    super()
+
     if (!globalScope) {
       // We could not determine the runtime environment. Short-circuite the agent here
       // to avoid possible exceptions later that may cause issues with customer's application.
@@ -84,4 +91,38 @@ export class Agent {
       return false
     }
   }
+
+  /* Below API methods are only available on a standard agent and not the micro agent */
+
+  /**
+   * Adds a JavaScript object with a custom name, start time, etc. to an in-progress session trace.
+   * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/addtotrace/}
+   * @param {{name: string, start: number, end?: number, origin?: string, type?: string}} customAttributes Supply a JavaScript object with these required and optional name/value pairs:
+   *
+   * - Required name/value pairs: name, start
+   * - Optional name/value pairs: end, origin, type
+   *
+   * If you are sending the same event object to New Relic as a PageAction, omit the TYPE attribute. (type is a string to describe what type of event you are marking inside of a session trace.) If included, it will override the event type and cause the PageAction event to be sent incorrectly. Instead, use the name attribute for event information.
+   */
+  addToTrace (customAttributes) {
+    warn('Call to agent api addToTrace failed. The page action feature is not currently initialized.')
+  }
+
+  /**
+   * Gives SPA routes more accurate names than default names. Monitors specific routes rather than by default grouping.
+   * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/setcurrentroutename/}
+   * @param {string} name Current route name for the page.
+   */
+  setCurrentRouteName (name) {
+    warn('Call to agent api setCurrentRouteName failed. The spa feature is not currently initialized.')
+  }
+
+  /**
+   * Returns a new API object that is bound to the current SPA interaction.
+   * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/interaction/}
+   * @returns {InteractionInstance} An API object that is bound to a specific BrowserInteraction event. Each time this method is called for the same BrowserInteraction, a new object is created, but it still references the same interaction.
+   */
+  interaction () {
+    warn('Call to agent api interaction failed. The spa feature is not currently initialized.')
+  }
 }

package/src/loaders/api/api.js

@@ -127,7 +127,7 @@ export function setAPI (agentIdentifier, forceDrain) {
           try {
             return cb.apply(this, arguments)
           } catch (err) {
-            tracerEE.emit('fn-err', [arguments, this, typeof err == 'string' ? new Error(err) : err], contextStore)
+            tracerEE.emit('fn-err', [arguments, this, err], contextStore)
             // the error came from outside the agent, so don't swallow
             throw err
           } finally {

package/src/loaders/api/interaction-types.js

@@ -0,0 +1,80 @@
+/**
+ * @typedef InteractionInstance
+ * @property {actionText} actionText
+ * @property {createTracer} createTracer
+ * @property {end} end
+ * @property {getContext} getContext
+ * @property {ignore} ignore
+ * @property {onEnd} onEnd
+ * @property {onEnd} save
+ * @property {setAttribute} setAttribute
+ * @property {setName} setName
+ */
+
+/**
+ * Sets the text value of the HTML element that was clicked to start a browser interaction.
+ * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/actiontext/}
+ * @callback actionText
+ * @param {string} value The text value of the HTML element that represents the action that started the interaction.
+ * @returns {InteractionInstance} Returns the same interaction object allowing method chaining.
+ */
+
+/**
+ * Times sub-components of a SPA interaction separately, including wait time and JS execution time.
+ * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/createtracer/}
+ * @callback createTracer
+ * @param {string} name This will be used as the name of the tracer.
+ * @param {string} [callback] A callback that contains the synchronous work to run at the end of the async work. To execute this callback, call the wrapper function returned using createTracer().
+ * @returns {Function} Returns a method that wraps the original callback. When this method is invoked, it calls the original callback and ends the async timing.
+ */
+
+/**
+ * Ends the SPA interaction at the current time.
+ * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/end/}
+ * @callback end
+ * @returns {InteractionInstance} Returns the same interaction object allowing method chaining.
+ */
+
+/**
+ * Stores values for the current SPA interaction asynchronously in browser.
+ * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/getcontext/}
+ * @callback getContext
+ * @param {(ctx: object) => void} callback This function is called when the interaction ends. It is called with one parameter, which is the interaction context.
+ * @returns {InteractionInstance} Returns the same interaction object allowing method chaining.
+ */
+
+/**
+ * Change the values associated with a SPA interaction before the interaction is saved.
+ * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/onend/}
+ * @callback onEnd
+ * @param {(ctx: object) => void} callback This function is called when the interaction ends. It is called with one parameter, which is the interaction context.
+ * @returns {InteractionInstance} Returns the same interaction object allowing method chaining.
+ */
+
+/**
+ * Ensures a SPA browser interaction will be saved when it ends.
+ * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/save/}
+ * @callback save
+ * @returns {InteractionInstance} Returns the same interaction object allowing method chaining.
+ */
+
+/**
+ * Adds a custom SPA attribute only to the current interaction in browser.
+ * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/setattribute/}
+ * @callback setAttribute
+ * @param {string} key Used as the attribute name on the BrowserInteraction event.
+ * @param {any} key Used as the attribute value on the BrowserInteraction event. This can be a string, number, boolean, or object. If it is an object, New Relic serializes it to a JSON string.
+ * @returns {InteractionInstance} Returns the same interaction object allowing method chaining.
+ */
+
+/**
+ * Sets the name and trigger of a SPA's browser interaction that is not a route change or URL change.
+ * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/setname/}
+ * @callback setName
+ * @param {string} name If null, the name will be set using the targetGroupedUrl attribute. If not null, this will set the browserInteractionName attribute in the BrowserInteraction event.
+ * @param {string} [trigger] If not null, this will set the TRIGGER attribute on the BrowserInteraction event.
+ * @returns {InteractionInstance} Returns the same interaction object allowing method chaining.
+ */
+
+/* istanbul ignore next */
+export const unused = {}

package/src/loaders/configure/configure.js

@@ -1,7 +1,7 @@
 import { setAPI, setTopLevelCallers } from '../api/api'
 import { addToNREUM, gosCDN, gosNREUMInitializedAgents } from '../../common/window/nreum'
 import { setConfiguration, setInfo, setLoaderConfig, setRuntime } from '../../common/config/config'
-import { activateFeatures, activatedFeatures } from '../../common/util/feature-flags'
+import { activatedFeatures } from '../../common/util/feature-flags'
 import { isWorkerScope } from '../../common/constants/runtime'
 
 export function configure (agentIdentifier, opts = {}, loaderType, forceDrain) {
@@ -15,15 +15,16 @@ export function configure (agentIdentifier, opts = {}, loaderType, forceDrain) {
 
   setConfiguration(agentIdentifier, init || {})
   setLoaderConfig(agentIdentifier, loader_config || {})
-  setRuntime(agentIdentifier, runtime)
 
   info.jsAttributes ??= {}
   if (isWorkerScope) { // add a default attr to all worker payloads
     info.jsAttributes.isWorker = true
   }
-
   setInfo(agentIdentifier, info)
 
+  runtime.denyList = init.ajax?.block_internal ? (init.ajax.deny_list || []).concat(info.beacon, info.errorBeacon) : init.ajax?.deny_list
+  setRuntime(agentIdentifier, runtime)
+
   setTopLevelCallers()
   const api = setAPI(agentIdentifier, forceDrain)
   gosNREUMInitializedAgents(agentIdentifier, api, 'api')

package/src/loaders/micro-agent.js

@@ -10,6 +10,7 @@ import { getConfiguration, getInfo, getLoaderConfig, getRuntime } from '../commo
 import { FEATURE_NAMES } from './features/features'
 import { warn } from '../common/util/console'
 import { onWindowLoad } from '../common/window/load'
+import { AgentBase } from './agent-base'
 
 const nonAutoFeatures = [
   FEATURE_NAMES.jserrors,
@@ -22,12 +23,14 @@ const nonAutoFeatures = [
  * automatically instrument. Instead, each MicroAgent instance will lazy load the required features and can support loading multiple instances on one page.
  * Out of the box, it can manually handle and report Page View, Page Action, and Error events.
  */
-export class MicroAgent {
+export class MicroAgent extends AgentBase {
   /**
    * @param {Object} options - Specifies features and runtime configuration,
    * @param {string=} agentIdentifier - The optional unique ID of the agent.
    */
   constructor (options, agentIdentifier = generateRandomHexString(16)) {
+    super()
+
     this.agentIdentifier = agentIdentifier
     this.sharedAggregator = new Aggregator({ agentIdentifier: this.agentIdentifier })
     this.features = {}

package/dist/cjs/features/jserrors/instrument/debug.js

@@ -1,40 +0,0 @@
-"use strict";
-
-var _contextualEe = require("../../../common/event-emitter/contextual-ee");
-var _mapOwn = require("../../../common/util/map-own");
-/*
- * Copyright 2020 New Relic Corporation. All rights reserved.
- * SPDX-License-Identifier: Apache-2.0
- */
-
-var flags = {};
-var flagArr;
-try {
-  flagArr = localStorage.getItem('__nr_flags').split(',');
-  if (console && typeof console.log === 'function') {
-    flags.console = true;
-    if (flagArr.indexOf('dev') !== -1) flags.dev = true;
-    if (flagArr.indexOf('nr_dev') !== -1) flags.nrDev = true;
-  }
-} catch (err) {
-  // no op
-}
-if (flags.nrDev) _contextualEe.ee.on('internal-error', function (err) {
-  log(err.stack);
-});
-if (flags.dev) _contextualEe.ee.on('fn-err', function (args, origThis, err) {
-  log(err.stack);
-});
-if (flags.dev) {
-  log('NR AGENT IN DEVELOPMENT MODE');
-  log('flags: ' + (0, _mapOwn.mapOwn)(flags, function (key, val) {
-    return key;
-  }).join(', '));
-}
-function log(message) {
-  try {
-    if (flags.console) log(message);
-  } catch (err) {
-    // no op
-  }
-}

package/dist/esm/features/jserrors/instrument/debug.js

@@ -1,38 +0,0 @@
-/*
- * Copyright 2020 New Relic Corporation. All rights reserved.
- * SPDX-License-Identifier: Apache-2.0
- */
-
-import { ee } from '../../../common/event-emitter/contextual-ee';
-import { mapOwn } from '../../../common/util/map-own';
-var flags = {};
-var flagArr;
-try {
-  flagArr = localStorage.getItem('__nr_flags').split(',');
-  if (console && typeof console.log === 'function') {
-    flags.console = true;
-    if (flagArr.indexOf('dev') !== -1) flags.dev = true;
-    if (flagArr.indexOf('nr_dev') !== -1) flags.nrDev = true;
-  }
-} catch (err) {
-  // no op
-}
-if (flags.nrDev) ee.on('internal-error', function (err) {
-  log(err.stack);
-});
-if (flags.dev) ee.on('fn-err', function (args, origThis, err) {
-  log(err.stack);
-});
-if (flags.dev) {
-  log('NR AGENT IN DEVELOPMENT MODE');
-  log('flags: ' + mapOwn(flags, function (key, val) {
-    return key;
-  }).join(', '));
-}
-function log(message) {
-  try {
-    if (flags.console) log(message);
-  } catch (err) {
-    // no op
-  }
-}

package/dist/types/features/jserrors/instrument/debug.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=debug.d.ts.map

package/dist/types/features/jserrors/instrument/debug.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"debug.d.ts","sourceRoot":"","sources":["../../../../../src/features/jserrors/instrument/debug.js"],"names":[],"mappings":""}

package/src/features/jserrors/instrument/debug.js

@@ -1,36 +0,0 @@
-/*
- * Copyright 2020 New Relic Corporation. All rights reserved.
- * SPDX-License-Identifier: Apache-2.0
- */
-
-import { ee } from '../../../common/event-emitter/contextual-ee'
-import { mapOwn } from '../../../common/util/map-own'
-
-var flags = {}
-var flagArr
-
-try {
-  flagArr = localStorage.getItem('__nr_flags').split(',')
-  if (console && typeof console.log === 'function') {
-    flags.console = true
-    if (flagArr.indexOf('dev') !== -1) flags.dev = true
-    if (flagArr.indexOf('nr_dev') !== -1) flags.nrDev = true
-  }
-} catch (err) {
-  // no op
-}
-
-if (flags.nrDev) ee.on('internal-error', function (err) { log(err.stack) })
-if (flags.dev) ee.on('fn-err', function (args, origThis, err) { log(err.stack) })
-if (flags.dev) {
-  log('NR AGENT IN DEVELOPMENT MODE')
-  log('flags: ' + mapOwn(flags, function (key, val) { return key }).join(', '))
-}
-
-function log (message) {
-  try {
-    if (flags.console) log(message)
-  } catch (err) {
-    // no op
-  }
-}