@newrelic/browser-agent 1.234.0 → 1.236.0

package/README.md

@@ -6,7 +6,7 @@ The New Relic browser agent instruments your web application or site and provide
 
 - The instructions on this page pertain to installing the browser agent as an NPM package.
 
-- The browser agent is also generally available as a copy-paste JavaScript snippet and via auto-injection by backend apps. See *[Install the browser agent](https://docs.newrelic.com/docs/browser/browser-monitoring/installation/install-browser-monitoring-agent/)* for info on these alternatives.
+- The browser agent is also generally available as a copy-paste JavaScript snippet and via auto-injection by backend apps. See *[Install the browser agent](https://docs.newrelic.com/docs/browser/browser-monitoring/installation/install-browser-monitoring-agent/)* for info on these alternatives. Releases are deployed to customers gradually, so the version available via these other methods often lags the current release of this package.
 
 - For questions and feedback on this package, please visit the [Explorer's Hub](https://forum.newrelic.com/s/), New Relic's community support forum.
 
@@ -131,7 +131,47 @@ import { SessionTrace } from '@newrelic/browser-agent/features/session_trace';
 import { Spa } from '@newrelic/browser-agent/features/spa';
 ```
 
-## Supported Browsers
+## Deploying one or more "micro" agents per page
+
+The examples above use the `Agent` class at their core, which is ideal for most cases as it will automatically detect page-level events across your web application.
+
+Using the `MicroAgent` class, it is possible to skip the "auto" instrumentation phases of the other loader types, and provide a *very small* agent designed for capturing data in a controlled manner via the API interfaces. The `MicroAgent` captures a distinct `PageView` event when instantiated, and additional `PageAction` and `JavaScriptError` events may be captured by calling the `noticeError` and `addPageAction` methods.
+
+Because it does not wrap the page-level globals in the same way as the base `Agent` class, the `MicroAgent` is not only smaller but can easily be instantiated multiple times on a single page with low overhead, with each instance configured to report to a different Browser App entity in New Relic One if desired. This accommodates specialized use cases, such as segmented UI designs (e.g., the micro front-end pattern) or applications requiring subsets of manually-handled data to be reported to different application entities.
+
+The example below illustrates how to instantiate and interact with two separate `MicroAgent` instances on one page.
+
+```javascript
+import { MicroAgent } from '@newrelic/browser-agent/loaders/micro-agent'
+
+const options_1 = {
+  info: { ... }, // configuration for application 1
+  loader_config: { ... },
+  init: { ... }
+}
+
+const microAgent1 = new MicroAgent(options_1)
+
+const options_2 = {
+  info: { ... }, // configuration for application 2
+  loader_config: { ... },
+  init: { ... }
+}
+
+const microAgent2 = new MicroAgent(options_2)
+
+// manually handle a JavaScript Error with microAgent1
+try{
+  ...
+} catch(err) {
+  microAgent1.noticeError(err)
+}
+
+// manually capture a Page Action with microAgent2
+microAgent2.addPageAction('myData', {hello: 'world'})
+```
+
+## Supported browsers
 
 Our supported browser list can be accessed [here](https://docs.newrelic.com/docs/browser/new-relic-browser/getting-started/compatibility-requirements-browser-monitoring/#browser-types).
 

package/dist/cjs/common/config/state/init.js

@@ -66,6 +66,9 @@ const model = () => {
       enabled: true,
       harvestTimeSeconds: 10
     },
+    harvest: {
+      tooManyRequestsDelay: 60
+    },
     session_replay: {
       // feature settings
       enabled: false,

package/dist/cjs/common/config/state/runtime.js

@@ -7,7 +7,7 @@ exports.getRuntime = getRuntime;
 exports.setRuntime = setRuntime;
 var _configurable = require("./configurable");
 var _nreum = require("../../window/nreum");
-var _globalScope = require("../../util/global-scope");
+var _runtime = require("../../constants/runtime");
 var _env = require("../../constants/env.npm");
 const model = {
   buildEnv: _env.BUILD_ENV,
@@ -23,13 +23,13 @@ const model = {
   maxBytes: 30000,
   // The "timeOrigin" property is the new standard timestamp property shared across main frame and workers, but is not supported in some early Safari browsers (safari<15) + IE
   // ingest expects an integer value, and timeOrigin can return a float.
-  offset: Math.floor(_globalScope.globalScope?.performance?.timeOrigin || _globalScope.globalScope?.performance?.timing?.navigationStart || Date.now()),
+  offset: Math.floor(_runtime.globalScope?.performance?.timeOrigin || _runtime.globalScope?.performance?.timing?.navigationStart || Date.now()),
   onerror: undefined,
-  origin: '' + _globalScope.globalScope.location,
+  origin: '' + _runtime.globalScope.location,
   ptid: undefined,
   releaseIds: {},
   session: undefined,
-  xhrWrappable: typeof _globalScope.globalScope.XMLHttpRequest?.prototype?.addEventListener === 'function',
+  xhrWrappable: typeof _runtime.globalScope.XMLHttpRequest?.prototype?.addEventListener === 'function',
   version: _env.VERSION
 };
 const _cache = {};

package/dist/cjs/common/constants/env.cdn.js

@@ -12,14 +12,14 @@ exports.VERSION = exports.DIST_METHOD = exports.BUILD_ENV = void 0;
 /**
  * Exposes the version of the agent
  */
-const VERSION = "1.234.0";
+const VERSION = "1.236.0";
 
 /**
  * Exposes the build type of the agent
  * Valid values are LOCAL, PROD, DEV
  */
 exports.VERSION = VERSION;
-const BUILD_ENV = undefined;
+const BUILD_ENV = "CDN";
 
 /**
  * Exposes the distribution method of the agent

package/dist/cjs/common/constants/env.npm.js

@@ -12,7 +12,7 @@ exports.VERSION = exports.DIST_METHOD = exports.BUILD_ENV = void 0;
 /**
  * Exposes the version of the agent
  */
-const VERSION = "1.234.0";
+const VERSION = "1.236.0";
 
 /**
  * Exposes the build type of the agent

package/dist/cjs/common/constants/runtime.js

@@ -0,0 +1,52 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.supportsSendBeacon = exports.isiOS = exports.isWorkerScope = exports.isIE = exports.isBrowserScope = exports.initialLocation = exports.iOS_below16 = exports.globalScope = exports.ffVersion = void 0;
+/**
+ * @file Contains constants about the environment the agent is running
+ * within. These values are derived at the time the agent is first loaded.
+ * @copyright 2023 New Relic Corporation. All rights reserved.
+ * @license Apache-2.0
+ */
+
+/**
+ * Indicates if the agent is running within a normal browser window context.
+ */
+const isBrowserScope = typeof window !== 'undefined' && !!window.document;
+
+/**
+ * Indicates if the agent is running within a worker context.
+ */
+exports.isBrowserScope = isBrowserScope;
+const isWorkerScope = typeof WorkerGlobalScope !== 'undefined' && (typeof self !== 'undefined' && self instanceof WorkerGlobalScope && self.navigator instanceof WorkerNavigator || typeof globalThis !== 'undefined' && globalThis instanceof WorkerGlobalScope && globalThis.navigator instanceof WorkerNavigator);
+exports.isWorkerScope = isWorkerScope;
+const globalScope = isBrowserScope ? window : typeof WorkerGlobalScope !== 'undefined' && (typeof self !== 'undefined' && self instanceof WorkerGlobalScope && self || typeof globalThis !== 'undefined' && globalThis instanceof WorkerGlobalScope && globalThis);
+exports.globalScope = globalScope;
+const initialLocation = '' + globalScope?.location;
+exports.initialLocation = initialLocation;
+const isiOS = /iPad|iPhone|iPod/.test(navigator.userAgent);
+
+/**
+ * Shared Web Workers introduced in iOS 16.0+ and n/a in 15.6-
+ *
+ * It was discovered in Safari 14 (https://bugs.webkit.org/show_bug.cgi?id=225305) that the buffered flag in PerformanceObserver
+ * did not work. This affects our onFCP metric in particular since web-vitals uses that flag to retrieve paint timing entries.
+ * This was fixed in v16+.
+ */
+exports.isiOS = isiOS;
+const iOS_below16 = isiOS && typeof SharedWorker === 'undefined';
+exports.iOS_below16 = iOS_below16;
+const ffVersion = (() => {
+  const match = navigator.userAgent.match(/Firefox[/\s](\d+\.\d+)/);
+  if (Array.isArray(match) && match.length >= 2) {
+    return +match[1];
+  }
+  return 0;
+})();
+exports.ffVersion = ffVersion;
+const isIE = Boolean(isBrowserScope && window.document.documentMode); // deprecated property that only works in IE
+exports.isIE = isIE;
+const supportsSendBeacon = !!navigator.sendBeacon;
+exports.supportsSendBeacon = supportsSendBeacon;

package/dist/cjs/common/constants/shared-channel.js

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.sharedChannel = void 0;
+/**
+ * @file Keeps an object alive that is passed to all feature aggregate modules.
+ * The purpose is to have a way for communication and signals to relay across features at runtime.
+ * This object can hold any arbitrary values and should be treated as on-the-fly dynamic.
+ */
+
+let onReplayReady;
+const sessionReplayInitialized = new Promise(resolve => onReplayReady = resolve);
+const sharedChannel = Object.freeze({
+  onReplayReady,
+  sessionReplayInitialized
+});
+exports.sharedChannel = sharedChannel;

package/dist/cjs/common/event-listener/event-listener-opts.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.documentAddEventListener = documentAddEventListener;
 exports.eventListenerOpts = eventListenerOpts;
 exports.windowAddEventListener = windowAddEventListener;
-var _globalScope = require("../util/global-scope");
+var _runtime = require("../constants/runtime");
 /*
  * See https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener#safely_detecting_option_support
  */
@@ -24,8 +24,8 @@ try {
       return false;
     }
   };
-  _globalScope.globalScope.addEventListener('test', null, options);
-  _globalScope.globalScope.removeEventListener('test', null, options);
+  _runtime.globalScope.addEventListener('test', null, options);
+  _runtime.globalScope.removeEventListener('test', null, options);
 } catch (err) {}
 function eventListenerOpts(useCapture, abortSignal) {
   return passiveSupported || signalSupported ? {

package/dist/cjs/common/harvest/harvest-scheduler.js

@@ -4,11 +4,14 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.HarvestScheduler = void 0;
-var _submitData = require("../util/submit-data");
+var submitData = _interopRequireWildcard(require("../util/submit-data"));
 var _sharedContext = require("../context/shared-context");
 var _harvest = require("./harvest");
 var _eol = require("../unload/eol");
 var _config = require("../config/config");
+var _sessionEntity = require("../session/session-entity");
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 /*
  * Copyright 2020 New Relic Corporation. All rights reserved.
  * SPDX-License-Identifier: Apache-2.0
@@ -42,9 +45,18 @@ class HarvestScheduler extends _sharedContext.SharedContext {
     // unload if EOL mechanism fires
     (0, _eol.subscribeToEOL)(this.unload.bind(this), (0, _config.getConfigurationValue)(this.sharedContext.agentIdentifier, 'allow_bfcache')); // TO DO: remove feature flag after rls stable
 
-    // unload if session resets
-    this.sharedContext?.ee.on('session-reset', this.unload.bind(this));
+    /* Flush all buffered data if session resets and give up retries. This should be synchronous to ensure that the correct `session` value is sent.
+      Since session-reset generates a new session ID and the ID is grabbed at send-time, any delays or retries would cause the payload to be sent under
+      the wrong session ID. */
+    this.sharedContext?.ee.on(_sessionEntity.SESSION_EVENTS.RESET, () => this.runHarvest({
+      forceNoRetry: true
+    }));
   }
+
+  /**
+   * This function is only meant for the last outgoing harvest cycle of a page. It trickles down to using sendBeacon, which should not be used
+   * to send payloads while the page is still active, due to limitations on how much data can be buffered in the API at any one time.
+   */
   unload() {
     if (this.aborted) return;
     // If opts.onUnload is defined, these are special actions to execute before attempting to send the final payload.
@@ -68,26 +80,36 @@ class HarvestScheduler extends _sharedContext.SharedContext {
   }
   scheduleHarvest(delay, opts) {
     if (this.timeoutHandle) return;
-    var timer = this;
     if (delay == null) {
       delay = this.interval;
     }
     this.timeoutHandle = setTimeout(() => {
-      timer.timeoutHandle = null;
-      timer.runHarvest(opts);
+      this.timeoutHandle = null;
+      this.runHarvest(opts);
     }, delay * 1000);
   }
   runHarvest(opts) {
     if (this.aborted) return;
-    var scheduler = this;
+
+    /**
+     * This is executed immediately after harvest sends the data via XHR, or if there's nothing to send. Note that this excludes on unloading / sendBeacon.
+     * @param {Object} result
+     */
+    const cbRanAfterSend = result => {
+      if (opts?.forceNoRetry) result.retry = false; // discard unsent data rather than re-queuing for next harvest attempt
+      this.onHarvestFinished(opts, result);
+    };
     let harvests = [];
     let submitMethod;
+    let payload;
     if (this.opts.getPayload) {
-      // Ajax & PVT & SR
-      submitMethod = (0, _harvest.getSubmitMethod)(this.endpoint, opts);
+      // Ajax & PVT & SR features provide a callback function to get data for harvesting
+      submitMethod = submitData.getSubmitMethod({
+        isFinalHarvest: opts?.unload
+      });
       if (!submitMethod) return false;
-      const retry = submitMethod.method === _submitData.submitData.xhr;
-      var payload = this.opts.getPayload({
+      const retry = !opts?.unload && submitMethod === submitData.xhr;
+      payload = this.opts.getPayload({
         retry: retry
       });
       if (!payload) {
@@ -116,7 +138,7 @@ class HarvestScheduler extends _sharedContext.SharedContext {
         payload,
         opts,
         submitMethod,
-        cbFinished: onHarvestFinished,
+        cbFinished: cbRanAfterSend,
         customUrl: this.opts.customUrl,
         raw: this.opts.raw
       });
@@ -125,16 +147,13 @@ class HarvestScheduler extends _sharedContext.SharedContext {
       this.scheduleHarvest();
     }
     return;
-    function onHarvestFinished(result) {
-      if (result.blocked) scheduler.onHarvestBlocked(opts, result);else scheduler.onHarvestFinished(opts, result);
-    }
   }
   onHarvestFinished(opts, result) {
     if (this.opts.onFinished) {
       this.opts.onFinished(result);
     }
     if (result.sent && result.retry) {
-      var delay = result.delay || this.opts.retryDelay;
+      const delay = result.delay || this.opts.retryDelay;
       // reschedule next harvest if should be delayed longer
       if (this.started && delay) {
         clearTimeout(this.timeoutHandle);