@newrelic/browser-agent 1.309.0-rc.7 → 1.309.0-rc.8

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

@@ -17,7 +17,7 @@ exports.VERSION = exports.RRWEB_VERSION = exports.RRWEB_PACKAGE_NAME = exports.D
 /**
  * Exposes the version of the agent
  */
-const VERSION = exports.VERSION = "1.309.0-rc.7";
+const VERSION = exports.VERSION = "1.309.0-rc.8";
 
 /**
  * Exposes the build type of the agent

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

@@ -17,7 +17,7 @@ exports.VERSION = exports.RRWEB_VERSION = exports.RRWEB_PACKAGE_NAME = exports.D
 /**
  * Exposes the version of the agent
  */
-const VERSION = exports.VERSION = "1.309.0-rc.7";
+const VERSION = exports.VERSION = "1.309.0-rc.8";
 
 /**
  * Exposes the build type of the agent

package/dist/cjs/common/util/script-tracker.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.findScriptTimings = findScriptTimings;
 var _runtime = require("../constants/runtime");
+var _now = require("../timing/now");
 var _cleanUrl = require("../url/clean-url");
 var _browserStackMatchers = require("./browser-stack-matchers");
 /**
@@ -12,6 +13,44 @@ var _browserStackMatchers = require("./browser-stack-matchers");
  * SPDX-License-Identifier: Apache-2.0
  */
 
+/**
+ * @typedef {import('./register-api-types').RegisterAPITimings} RegisterAPITimings
+ */
+
+/** @type {(entry: PerformanceEntry) => boolean} - A shared function to determine if a performance entry is a valid script or link resource for evaluation */
+const validEntryCriteria = entry => entry.initiatorType === 'script' || entry.initiatorType === 'link' && entry.name.endsWith('.js');
+
+/** @type {Set<PerformanceResourceTiming>} - A set of resource timing objects that are "valid" -- see "validEntryCriteria" */
+const scripts = new Set();
+/** @type {Array<{ test: (entry: PerformanceEntry) => boolean, addedAt: number }>} an array of PerformanceObserver subscribers to check for late emissions */
+let poSubscribers = [];
+if (_runtime.globalScope.PerformanceObserver?.supportedEntryTypes.includes('resource')) {
+  /** We must track the script assets this way, because the performance buffer can fill up and when it does that
+   * it stops accepting new entries (instead of dropping old entries), which means if the register API is called
+   * after the buffer fills up we won't be able to get the script timing information from the resource timing API
+  */
+  const scriptObserver = new PerformanceObserver(list => {
+    list.getEntries().forEach(entry => {
+      if (validEntryCriteria(entry)) {
+        if (scripts.size > 250) scripts.delete(scripts.values().next().value); // keep the set from growing indefinitely, we only need to check recent entries against the stack of the register API caller, so we can drop old entries as new ones come in
+        scripts.add(entry);
+        const canClear = [];
+        poSubscribers.forEach(({
+          test,
+          addedAt
+        }, idx) => {
+          if (test(entry) || (0, _now.now)() - addedAt > 10000) canClear.push(idx); // Clear subscribers that have resolved or have been pending for more than 10 seconds
+        });
+        poSubscribers = poSubscribers.filter((_, idx) => !canClear.includes(idx));
+      }
+    });
+  });
+  scriptObserver.observe({
+    type: 'resource',
+    buffered: true
+  });
+}
+
 /**
  * Extracts URLs from stack traces using the same logic as compute-stack-trace.js
  * @param {string} stack The error stack trace
@@ -48,31 +87,95 @@ function getDeepStackTrace() {
   return stack;
 }
 
+/**
+ * Indicates whether the provided URL matches any script preload link tags in the document.
+ * @param {string} targetUrl The URL to match against preload tags
+ * @returns {boolean} True if a matching preload link is found, false otherwise
+ */
+function wasPreloaded(targetUrl) {
+  if (!targetUrl || !_runtime.globalScope.document) return false;
+  try {
+    const linkTags = _runtime.globalScope.document.querySelectorAll('link[rel="preload"][as="script"]');
+    for (const link of linkTags) {
+      // link.href is resolved to an absolute URL by the browser (even if supplied as relative), so we can match exactly against the cleaned target URL
+      if ((0, _cleanUrl.cleanURL)(link.href) === targetUrl) return true;
+    }
+  } catch (error) {
+    // Don't let DOM parsing errors break anything
+  }
+  return false;
+}
+
 /**
  * Uses the stack of the initiator function, returns script timing information if a script can be found with the resource timing API matching the URL found in the stack.
- * @returns {{fetchStart: number, fetchEnd: number, asset: string|undefined}} Object containing script fetch start and end times, and the asset URL if found
+ * @returns {RegisterAPITimings} Object containing script fetch start and end times, and the asset URL if found
  */
 function findScriptTimings() {
-  const stack = getDeepStackTrace();
   const timings = {
+    registeredAt: (0, _now.now)(),
+    reportedAt: undefined,
     fetchStart: 0,
     fetchEnd: 0,
-    asset: undefined
+    asset: undefined,
+    type: 'unknown'
   };
-  const scripts = _runtime.globalScope.performance?.getEntriesByType('resource').filter(entry => entry.initiatorType === 'script') || [];
-  if (scripts.length < 1 || !stack) return timings;
+  const stack = getDeepStackTrace();
+  if (!stack) return timings;
+  const navUrl = _runtime.globalScope.performance?.getEntriesByType('navigation')?.find(entry => entry.initiatorType === 'navigation')?.name || '';
   try {
     const mfeScriptUrl = extractUrlsFromStack(stack).at(-1); // array of URLs from the stack of the register API caller, the MFE script should be at the bottom
     if (!mfeScriptUrl) return timings;
-    const match = scripts.find(script => {
-      const scriptUrl = (0, _cleanUrl.cleanURL)(script.name);
-      // Try exact match, then partial matches for different URL formats
-      return mfeScriptUrl === scriptUrl || mfeScriptUrl.endsWith(scriptUrl) || scriptUrl.endsWith(mfeScriptUrl);
-    });
+    if (navUrl.includes(mfeScriptUrl)) {
+      // this means the stack is indicating that the registration came from an inline script or eval, so we won't find a matching script resource - return early with just the URL
+      timings.asset = (0, _cleanUrl.cleanURL)(navUrl);
+      timings.type = 'inline';
+      return timings;
+    }
+
+    // try to find it in the static list, which updates faster than the PO.  This cant be solely trusted, since the buffer can fill up and stop accepting entries,
+    // but it can still help in cases where the check is made before the asset is emitted by the performance observer and the buffer is not full. Fallback to checking the PO
+    // entries that have been buffered as seen in the PO callback if its not found in the static list.
+    const match = performance.getEntriesByType('resource').find(entryMatchesMfe) || [...scripts].find(entryMatchesMfe);
     if (match) {
-      timings.fetchStart = Math.floor(match.startTime);
-      timings.fetchEnd = Math.floor(match.responseEnd);
-      timings.asset = match.name;
+      setMatchedAttributes(match);
+    } else {
+      // We didnt find a match with the PO, nor a static lookup... check if its preloaded and if so, set basic fallbacks and try to associate with a later script entry if possible, this can happen if the preload is reported late in the PO observer callback
+      if (wasPreloaded(mfeScriptUrl)) {
+        timings.asset = mfeScriptUrl;
+        timings.type = 'preload';
+        // wait for a late PO callback...  The timings object can be mutated after the fact since we return a pointer and not a cloned object
+        poSubscribers.push({
+          addedAt: (0, _now.now)(),
+          test: entry => {
+            if (entryMatchesMfe(entry)) {
+              setMatchedAttributes(entry);
+              return true; // return true so that we know to clear this callback from the pending list since we found our match, otherwise it will stay in the list and be called for future entries which is unnecessary after we found our match and can cause performance issues if there are a lot of future entries and pending callbacks
+            }
+            return false;
+          }
+        });
+      }
+    }
+
+    /**
+     * A matcher function to determine if a performance entry corresponds to the MFE script based on URL matching. It checks if either the entry URL ends with the MFE script URL or vice versa, to account for potential differences in how URLs are represented in the stack trace versus the resource timing entries.
+     * @param {PerformanceResourceTiming} entry - The resource timing entry to compare to the MFE script
+     * @returns {boolean} True if we think the entry matches the MFE script, false otherwise
+     */
+    function entryMatchesMfe(entry) {
+      const entryUrl = (0, _cleanUrl.cleanURL)(entry.name);
+      return entryUrl.endsWith(mfeScriptUrl) || mfeScriptUrl.endsWith(entryUrl);
+    }
+
+    /**
+     * A helper function to set the matched timing attributes on the timings object based on a performance entry. This is called when we have identified a resource timing entry that we believe corresponds to the MFE script, and we want to extract the fetch start and end times, as well as the asset URL and type.
+     * @param {PerformanceResourceTiming} entry - The resource timing entry to base values off of
+     */
+    function setMatchedAttributes(entry) {
+      timings.fetchStart = Math.floor(entry.startTime);
+      timings.fetchEnd = Math.floor(entry.responseEnd);
+      timings.asset = entry.name;
+      timings.type = entry.initiatorType;
     }
   } catch (error) {
     // Don't let stack parsing errors break anything

package/dist/cjs/loaders/api/register-api-types.js

@@ -33,18 +33,24 @@ exports.default = void 0;
 /**
  * @typedef {Object} RegisterAPIMetadata
  * @property {Object} customAttributes - The custom attributes for the registered entity.
- * @property {Object} timings - The timing metrics for the registered entity.
- * @property {number} timings.registeredAt - The timestamp when the registered entity was created.
- * @property {number} [timings.reportedAt] - The timestamp when the registered entity was deregistered.
- * @property {number} timings.fetchStart - The timestamp when the registered entity began fetching.
- * @property {number} timings.fetchEnd - The timestamp when the registered entity finished fetching.
- * @property {Object} [timings.asset] - The asset path (if found) for the registered entity.
- * @property {Object} target - The options for the registered entity.
- * @property {string} [target.licenseKey] - The license key for the registered entity. If none was supplied, it will assume the license key from the main agent.
- * @property {string} target.id - The ID for the registered entity.
- * @property {string} target.name - The name returned for the registered entity.
- * @property {{[key: string]: any}} [target.tags] - The tags for the registered entity as key-value pairs.
- * @property {string} [target.parentId] - The parentId for the registered entity. If none was supplied, it will assume the entity guid from the main agent.
- * @property {boolean} [target.isolated] - When true, each registration creates an isolated instance. When false, multiple registrations with the same id and isolated: false will share a single instance, including all custom attributes, ids, names, and metadata. Calling deregister on a shared instance will deregister it for all entities using the instance. Defaults to true.
+ * @property {RegisterAPITimings} timings - The timing metrics for the registered entity.
+ * @property {RegisterAPITarget} target - The options for the registered entity.
+ */
+/**
+ * @typedef {Object} RegisterAPITarget
+ * @property {string} id - The ID for the registered entity.
+ * @property {string} name - The name returned for the registered entity.
+ * @property {{[key: string]: any}} [tags] - The tags for the registered entity as key-value pairs.
+ * @property {string} [parentId] - The parentId for the registered entity. If none was supplied, it will assume the entity guid from the main agent.
+ * @property {boolean} [isolated] - When true, each registration creates an isolated instance. When false, multiple registrations with the same id and isolated: false will share a single instance, including all custom attributes, ids, names, and metadata. Calling deregister on a shared instance will deregister it for all entities using the instance. Defaults to true.
+ */
+/**
+ * @typedef {Object} RegisterAPITimings
+ * @property {number} registeredAt - The timestamp when the registered entity was created.
+ * @property {number} [reportedAt] - The timestamp when the registered entity was deregistered.
+ * @property {number} fetchStart - The timestamp when the registered entity began fetching.
+ * @property {number} fetchEnd - The timestamp when the registered entity finished fetching.
+ * @property {Object} [asset] - The asset path (if found) for the registered entity.
+ * @property {string} type - The type of timing associated with the registered entity, 'script' or 'link' if found with the performance resource API, 'inline' if found to be associated with the root document URL, or 'unknown' if no associated resource could be found.
  */
 var _default = exports.default = {};

package/dist/cjs/loaders/api/register.js

@@ -58,11 +58,7 @@ function register(agentRef, target, parent) {
   target.blocked = false;
   target.parent = parent || {};
   if (typeof target.tags !== 'object' || target.tags === null || Array.isArray(target.tags)) target.tags = {};
-  const timings = {
-    registeredAt: (0, _now.now)(),
-    reportedAt: undefined,
-    ...(0, _scriptTracker.findScriptTimings)()
-  };
+  const timings = (0, _scriptTracker.findScriptTimings)();
   const attrs = {};
 
   // Process tags object and add to attrs, excluding protected keys
@@ -175,6 +171,10 @@ function register(agentRef, target, parent) {
     if (timings.reportedAt) return;
     timings.reportedAt = (0, _now.now)();
     api.recordCustomEvent('MicroFrontEndTiming', {
+      assetUrl: timings.asset,
+      // the url of the script that was registered, or undefined if it could not be determined (inline or no match)
+      assetType: timings.type,
+      // the type of asset that was associated with the timings, one of 'script', 'link' (if preloaded and found in the resource timing buffer), 'preload' (if preloaded but not found in the resource timing buffer), or "unknown" if it could not be determined
       timeToLoad: timings.registeredAt - timings.fetchStart,
       // fetchStart to registeredAt
       timeToBeRequested: timings.fetchStart,

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

@@ -11,7 +11,7 @@
 /**
  * Exposes the version of the agent
  */
-export const VERSION = "1.309.0-rc.7";
+export const VERSION = "1.309.0-rc.8";
 
 /**
  * Exposes the build type of the agent

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

@@ -11,7 +11,7 @@
 /**
  * Exposes the version of the agent
  */
-export const VERSION = "1.309.0-rc.7";
+export const VERSION = "1.309.0-rc.8";
 
 /**
  * Exposes the build type of the agent

package/dist/esm/common/util/script-tracker.js

@@ -4,9 +4,48 @@
  */
 
 import { globalScope } from '../constants/runtime';
+import { now } from '../timing/now';
 import { cleanURL } from '../url/clean-url';
 import { chrome, gecko } from './browser-stack-matchers';
 
+/**
+ * @typedef {import('./register-api-types').RegisterAPITimings} RegisterAPITimings
+ */
+
+/** @type {(entry: PerformanceEntry) => boolean} - A shared function to determine if a performance entry is a valid script or link resource for evaluation */
+const validEntryCriteria = entry => entry.initiatorType === 'script' || entry.initiatorType === 'link' && entry.name.endsWith('.js');
+
+/** @type {Set<PerformanceResourceTiming>} - A set of resource timing objects that are "valid" -- see "validEntryCriteria" */
+const scripts = new Set();
+/** @type {Array<{ test: (entry: PerformanceEntry) => boolean, addedAt: number }>} an array of PerformanceObserver subscribers to check for late emissions */
+let poSubscribers = [];
+if (globalScope.PerformanceObserver?.supportedEntryTypes.includes('resource')) {
+  /** We must track the script assets this way, because the performance buffer can fill up and when it does that
+   * it stops accepting new entries (instead of dropping old entries), which means if the register API is called
+   * after the buffer fills up we won't be able to get the script timing information from the resource timing API
+  */
+  const scriptObserver = new PerformanceObserver(list => {
+    list.getEntries().forEach(entry => {
+      if (validEntryCriteria(entry)) {
+        if (scripts.size > 250) scripts.delete(scripts.values().next().value); // keep the set from growing indefinitely, we only need to check recent entries against the stack of the register API caller, so we can drop old entries as new ones come in
+        scripts.add(entry);
+        const canClear = [];
+        poSubscribers.forEach(({
+          test,
+          addedAt
+        }, idx) => {
+          if (test(entry) || now() - addedAt > 10000) canClear.push(idx); // Clear subscribers that have resolved or have been pending for more than 10 seconds
+        });
+        poSubscribers = poSubscribers.filter((_, idx) => !canClear.includes(idx));
+      }
+    });
+  });
+  scriptObserver.observe({
+    type: 'resource',
+    buffered: true
+  });
+}
+
 /**
  * Extracts URLs from stack traces using the same logic as compute-stack-trace.js
  * @param {string} stack The error stack trace
@@ -43,31 +82,95 @@ function getDeepStackTrace() {
   return stack;
 }
 
+/**
+ * Indicates whether the provided URL matches any script preload link tags in the document.
+ * @param {string} targetUrl The URL to match against preload tags
+ * @returns {boolean} True if a matching preload link is found, false otherwise
+ */
+function wasPreloaded(targetUrl) {
+  if (!targetUrl || !globalScope.document) return false;
+  try {
+    const linkTags = globalScope.document.querySelectorAll('link[rel="preload"][as="script"]');
+    for (const link of linkTags) {
+      // link.href is resolved to an absolute URL by the browser (even if supplied as relative), so we can match exactly against the cleaned target URL
+      if (cleanURL(link.href) === targetUrl) return true;
+    }
+  } catch (error) {
+    // Don't let DOM parsing errors break anything
+  }
+  return false;
+}
+
 /**
  * Uses the stack of the initiator function, returns script timing information if a script can be found with the resource timing API matching the URL found in the stack.
- * @returns {{fetchStart: number, fetchEnd: number, asset: string|undefined}} Object containing script fetch start and end times, and the asset URL if found
+ * @returns {RegisterAPITimings} Object containing script fetch start and end times, and the asset URL if found
  */
 export function findScriptTimings() {
-  const stack = getDeepStackTrace();
   const timings = {
+    registeredAt: now(),
+    reportedAt: undefined,
     fetchStart: 0,
     fetchEnd: 0,
-    asset: undefined
+    asset: undefined,
+    type: 'unknown'
   };
-  const scripts = globalScope.performance?.getEntriesByType('resource').filter(entry => entry.initiatorType === 'script') || [];
-  if (scripts.length < 1 || !stack) return timings;
+  const stack = getDeepStackTrace();
+  if (!stack) return timings;
+  const navUrl = globalScope.performance?.getEntriesByType('navigation')?.find(entry => entry.initiatorType === 'navigation')?.name || '';
   try {
     const mfeScriptUrl = extractUrlsFromStack(stack).at(-1); // array of URLs from the stack of the register API caller, the MFE script should be at the bottom
     if (!mfeScriptUrl) return timings;
-    const match = scripts.find(script => {
-      const scriptUrl = cleanURL(script.name);
-      // Try exact match, then partial matches for different URL formats
-      return mfeScriptUrl === scriptUrl || mfeScriptUrl.endsWith(scriptUrl) || scriptUrl.endsWith(mfeScriptUrl);
-    });
+    if (navUrl.includes(mfeScriptUrl)) {
+      // this means the stack is indicating that the registration came from an inline script or eval, so we won't find a matching script resource - return early with just the URL
+      timings.asset = cleanURL(navUrl);
+      timings.type = 'inline';
+      return timings;
+    }
+
+    // try to find it in the static list, which updates faster than the PO.  This cant be solely trusted, since the buffer can fill up and stop accepting entries,
+    // but it can still help in cases where the check is made before the asset is emitted by the performance observer and the buffer is not full. Fallback to checking the PO
+    // entries that have been buffered as seen in the PO callback if its not found in the static list.
+    const match = performance.getEntriesByType('resource').find(entryMatchesMfe) || [...scripts].find(entryMatchesMfe);
     if (match) {
-      timings.fetchStart = Math.floor(match.startTime);
-      timings.fetchEnd = Math.floor(match.responseEnd);
-      timings.asset = match.name;
+      setMatchedAttributes(match);
+    } else {
+      // We didnt find a match with the PO, nor a static lookup... check if its preloaded and if so, set basic fallbacks and try to associate with a later script entry if possible, this can happen if the preload is reported late in the PO observer callback
+      if (wasPreloaded(mfeScriptUrl)) {
+        timings.asset = mfeScriptUrl;
+        timings.type = 'preload';
+        // wait for a late PO callback...  The timings object can be mutated after the fact since we return a pointer and not a cloned object
+        poSubscribers.push({
+          addedAt: now(),
+          test: entry => {
+            if (entryMatchesMfe(entry)) {
+              setMatchedAttributes(entry);
+              return true; // return true so that we know to clear this callback from the pending list since we found our match, otherwise it will stay in the list and be called for future entries which is unnecessary after we found our match and can cause performance issues if there are a lot of future entries and pending callbacks
+            }
+            return false;
+          }
+        });
+      }
+    }
+
+    /**
+     * A matcher function to determine if a performance entry corresponds to the MFE script based on URL matching. It checks if either the entry URL ends with the MFE script URL or vice versa, to account for potential differences in how URLs are represented in the stack trace versus the resource timing entries.
+     * @param {PerformanceResourceTiming} entry - The resource timing entry to compare to the MFE script
+     * @returns {boolean} True if we think the entry matches the MFE script, false otherwise
+     */
+    function entryMatchesMfe(entry) {
+      const entryUrl = cleanURL(entry.name);
+      return entryUrl.endsWith(mfeScriptUrl) || mfeScriptUrl.endsWith(entryUrl);
+    }
+
+    /**
+     * A helper function to set the matched timing attributes on the timings object based on a performance entry. This is called when we have identified a resource timing entry that we believe corresponds to the MFE script, and we want to extract the fetch start and end times, as well as the asset URL and type.
+     * @param {PerformanceResourceTiming} entry - The resource timing entry to base values off of
+     */
+    function setMatchedAttributes(entry) {
+      timings.fetchStart = Math.floor(entry.startTime);
+      timings.fetchEnd = Math.floor(entry.responseEnd);
+      timings.asset = entry.name;
+      timings.type = entry.initiatorType;
     }
   } catch (error) {
     // Don't let stack parsing errors break anything

package/dist/esm/loaders/api/register-api-types.js

@@ -30,19 +30,27 @@
 /**
  * @typedef {Object} RegisterAPIMetadata
  * @property {Object} customAttributes - The custom attributes for the registered entity.
- * @property {Object} timings - The timing metrics for the registered entity.
- * @property {number} timings.registeredAt - The timestamp when the registered entity was created.
- * @property {number} [timings.reportedAt] - The timestamp when the registered entity was deregistered.
- * @property {number} timings.fetchStart - The timestamp when the registered entity began fetching.
- * @property {number} timings.fetchEnd - The timestamp when the registered entity finished fetching.
- * @property {Object} [timings.asset] - The asset path (if found) for the registered entity.
- * @property {Object} target - The options for the registered entity.
- * @property {string} [target.licenseKey] - The license key for the registered entity. If none was supplied, it will assume the license key from the main agent.
- * @property {string} target.id - The ID for the registered entity.
- * @property {string} target.name - The name returned for the registered entity.
- * @property {{[key: string]: any}} [target.tags] - The tags for the registered entity as key-value pairs.
- * @property {string} [target.parentId] - The parentId for the registered entity. If none was supplied, it will assume the entity guid from the main agent.
- * @property {boolean} [target.isolated] - When true, each registration creates an isolated instance. When false, multiple registrations with the same id and isolated: false will share a single instance, including all custom attributes, ids, names, and metadata. Calling deregister on a shared instance will deregister it for all entities using the instance. Defaults to true.
+ * @property {RegisterAPITimings} timings - The timing metrics for the registered entity.
+ * @property {RegisterAPITarget} target - The options for the registered entity.
+ */
+
+/**
+ * @typedef {Object} RegisterAPITarget
+ * @property {string} id - The ID for the registered entity.
+ * @property {string} name - The name returned for the registered entity.
+ * @property {{[key: string]: any}} [tags] - The tags for the registered entity as key-value pairs.
+ * @property {string} [parentId] - The parentId for the registered entity. If none was supplied, it will assume the entity guid from the main agent.
+ * @property {boolean} [isolated] - When true, each registration creates an isolated instance. When false, multiple registrations with the same id and isolated: false will share a single instance, including all custom attributes, ids, names, and metadata. Calling deregister on a shared instance will deregister it for all entities using the instance. Defaults to true.
+ */
+
+/**
+ * @typedef {Object} RegisterAPITimings
+ * @property {number} registeredAt - The timestamp when the registered entity was created.
+ * @property {number} [reportedAt] - The timestamp when the registered entity was deregistered.
+ * @property {number} fetchStart - The timestamp when the registered entity began fetching.
+ * @property {number} fetchEnd - The timestamp when the registered entity finished fetching.
+ * @property {Object} [asset] - The asset path (if found) for the registered entity.
+ * @property {string} type - The type of timing associated with the registered entity, 'script' or 'link' if found with the performance resource API, 'inline' if found to be associated with the root document URL, or 'unknown' if no associated resource could be found.
  */
 
 export default {};

package/dist/esm/loaders/api/register.js

@@ -52,11 +52,7 @@ function register(agentRef, target, parent) {
   target.blocked = false;
   target.parent = parent || {};
   if (typeof target.tags !== 'object' || target.tags === null || Array.isArray(target.tags)) target.tags = {};
-  const timings = {
-    registeredAt: now(),
-    reportedAt: undefined,
-    ...findScriptTimings()
-  };
+  const timings = findScriptTimings();
   const attrs = {};
 
   // Process tags object and add to attrs, excluding protected keys
@@ -169,6 +165,10 @@ function register(agentRef, target, parent) {
     if (timings.reportedAt) return;
     timings.reportedAt = now();
     api.recordCustomEvent('MicroFrontEndTiming', {
+      assetUrl: timings.asset,
+      // the url of the script that was registered, or undefined if it could not be determined (inline or no match)
+      assetType: timings.type,
+      // the type of asset that was associated with the timings, one of 'script', 'link' (if preloaded and found in the resource timing buffer), 'preload' (if preloaded but not found in the resource timing buffer), or "unknown" if it could not be determined
       timeToLoad: timings.registeredAt - timings.fetchStart,
       // fetchStart to registeredAt
       timeToBeRequested: timings.fetchStart,

package/dist/types/common/util/script-tracker.d.ts

@@ -1,10 +1,7 @@
 /**
  * Uses the stack of the initiator function, returns script timing information if a script can be found with the resource timing API matching the URL found in the stack.
- * @returns {{fetchStart: number, fetchEnd: number, asset: string|undefined}} Object containing script fetch start and end times, and the asset URL if found
+ * @returns {RegisterAPITimings} Object containing script fetch start and end times, and the asset URL if found
  */
-export function findScriptTimings(): {
-    fetchStart: number;
-    fetchEnd: number;
-    asset: string | undefined;
-};
+export function findScriptTimings(): RegisterAPITimings;
+export type RegisterAPITimings = any;
 //# sourceMappingURL=script-tracker.d.ts.map

package/dist/types/common/util/script-tracker.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"script-tracker.d.ts","sourceRoot":"","sources":["../../../../src/common/util/script-tracker.js"],"names":[],"mappings":"AA+CA;;;GAGG;AACH,qCAFa;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,GAAC,SAAS,CAAA;CAAC,CA2B3E"}
+{"version":3,"file":"script-tracker.d.ts","sourceRoot":"","sources":["../../../../src/common/util/script-tracker.js"],"names":[],"mappings":"AAqGA;;;GAGG;AACH,qCAFa,kBAAkB,CAmE9B"}

package/dist/types/loaders/api/register-api-types.d.ts

@@ -90,25 +90,60 @@ export type RegisterAPIMetadata = {
     /**
      * - The timing metrics for the registered entity.
      */
-    timings: {
-        registeredAt: number;
-        reportedAt?: number | undefined;
-        fetchStart: number;
-        fetchEnd: number;
-        asset?: Object | undefined;
-    };
+    timings: RegisterAPITimings;
     /**
      * - The options for the registered entity.
      */
-    target: {
-        licenseKey?: string | undefined;
-        id: string;
-        name: string;
-        tags?: {
-            [key: string]: any;
-        } | undefined;
-        parentId?: string | undefined;
-        isolated?: boolean | undefined;
-    };
+    target: RegisterAPITarget;
+};
+export type RegisterAPITarget = {
+    /**
+     * - The ID for the registered entity.
+     */
+    id: string;
+    /**
+     * - The name returned for the registered entity.
+     */
+    name: string;
+    /**
+     * - The tags for the registered entity as key-value pairs.
+     */
+    tags?: {
+        [key: string]: any;
+    } | undefined;
+    /**
+     * - The parentId for the registered entity. If none was supplied, it will assume the entity guid from the main agent.
+     */
+    parentId?: string | undefined;
+    /**
+     * - When true, each registration creates an isolated instance. When false, multiple registrations with the same id and isolated: false will share a single instance, including all custom attributes, ids, names, and metadata. Calling deregister on a shared instance will deregister it for all entities using the instance. Defaults to true.
+     */
+    isolated?: boolean | undefined;
+};
+export type RegisterAPITimings = {
+    /**
+     * - The timestamp when the registered entity was created.
+     */
+    registeredAt: number;
+    /**
+     * - The timestamp when the registered entity was deregistered.
+     */
+    reportedAt?: number | undefined;
+    /**
+     * - The timestamp when the registered entity began fetching.
+     */
+    fetchStart: number;
+    /**
+     * - The timestamp when the registered entity finished fetching.
+     */
+    fetchEnd: number;
+    /**
+     * - The asset path (if found) for the registered entity.
+     */
+    asset?: Object | undefined;
+    /**
+     * - The type of timing associated with the registered entity, 'script' or 'link' if found with the performance resource API, 'inline' if found to be associated with the root document URL, or 'unknown' if no associated resource could be found.
+     */
+    type: string;
 };
 //# sourceMappingURL=register-api-types.d.ts.map

package/dist/types/loaders/api/register-api-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"register-api-types.d.ts","sourceRoot":"","sources":["../../../../src/loaders/api/register-api-types.js"],"names":[],"mappings":";;;;;;mBAOc,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,KAAK,IAAI;;;;SAC3C,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,CAAA;KAAC,KAAK,IAAI;;;;iBACxH,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,EAAE,gBAAgB,CAAC,EAAE,MAAM,KAAK,IAAI;;;;cAC1D,CAAC,MAAM,EAAE,sBAAsB,KAAK,WAAW;;;;gBAC/C,MAAM,IAAI;;;;uBACV,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,KAAK,IAAI;;;;aAChD,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAC,KAAK,CAAC,EAAE,MAAM,GAAC,eAAe,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,GAAC,eAAe,CAAC;QAAC,gBAAgB,CAAC,EAAE,MAAM,CAAA;KAAC,KAAK,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,gBAAgB,EAAE,MAAM,CAAA;KAAC,CAAC;;;;2BACtM,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,KAAK,IAAI;;;;wBAC9B,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,EAAE,OAAO,CAAC,EAAE,OAAO,KAAK,IAAI;;;;eAClF,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,EAAE,YAAY,CAAC,EAAE,OAAO,KAAK,IAAI;;;;cACtD,mBAAmB;;;;;;QAKnB,MAAM,GAAC,MAAM;;;;UACb,MAAM;;;;;;;;;;;;;;;;;;;;sBAQN,MAAM;;;;aAEjB;QAA2B,YAAY,EAA5B,MAAM;QACW,UAAU;QACX,UAAU,EAA1B,MAAM;QACU,QAAQ,EAAxB,MAAM;QACW,KAAK;KACjC;;;;YACA;QAA2B,UAAU;QACX,EAAE,EAAjB,MAAM;QACS,IAAI,EAAnB,MAAM;QACwB,IAAI;;;QAClB,QAAQ;QACP,QAAQ;KACtC"}
+{"version":3,"file":"register-api-types.d.ts","sourceRoot":"","sources":["../../../../src/loaders/api/register-api-types.js"],"names":[],"mappings":";;;;;;mBAOc,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,KAAK,IAAI;;;;SAC3C,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,CAAA;KAAC,KAAK,IAAI;;;;iBACxH,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,EAAE,gBAAgB,CAAC,EAAE,MAAM,KAAK,IAAI;;;;cAC1D,CAAC,MAAM,EAAE,sBAAsB,KAAK,WAAW;;;;gBAC/C,MAAM,IAAI;;;;uBACV,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,KAAK,IAAI;;;;aAChD,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAC,KAAK,CAAC,EAAE,MAAM,GAAC,eAAe,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,GAAC,eAAe,CAAC;QAAC,gBAAgB,CAAC,EAAE,MAAM,CAAA;KAAC,KAAK,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,gBAAgB,EAAE,MAAM,CAAA;KAAC,CAAC;;;;2BACtM,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,KAAK,IAAI;;;;wBAC9B,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,EAAE,OAAO,CAAC,EAAE,OAAO,KAAK,IAAI;;;;eAClF,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,EAAE,YAAY,CAAC,EAAE,OAAO,KAAK,IAAI;;;;cACtD,mBAAmB;;;;;;QAKnB,MAAM,GAAC,MAAM;;;;UACb,MAAM;;;;;;;;;;;;;;;;;;;;sBAQN,MAAM;;;;aACN,kBAAkB;;;;YAClB,iBAAiB;;;;;;QAKjB,MAAM;;;;UACN,MAAM;;;;;;;;;;;;;;;;;;;;kBAQN,MAAM;;;;;;;;gBAEN,MAAM;;;;cACN,MAAM;;;;;;;;UAEN,MAAM"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@newrelic/browser-agent",
-  "version": "1.309.0-rc.7",
+  "version": "1.309.0-rc.8",
   "private": false,
   "author": "New Relic Browser Agent Team <browser-agent@newrelic.com>",
   "description": "New Relic Browser Agent",

package/src/common/util/script-tracker.js

@@ -4,9 +4,43 @@
  */
 
 import { globalScope } from '../constants/runtime'
+import { now } from '../timing/now'
 import { cleanURL } from '../url/clean-url'
 import { chrome, gecko } from './browser-stack-matchers'
 
+/**
+ * @typedef {import('./register-api-types').RegisterAPITimings} RegisterAPITimings
+ */
+
+/** @type {(entry: PerformanceEntry) => boolean} - A shared function to determine if a performance entry is a valid script or link resource for evaluation */
+const validEntryCriteria = entry => entry.initiatorType === 'script' || (entry.initiatorType === 'link' && entry.name.endsWith('.js'))
+
+/** @type {Set<PerformanceResourceTiming>} - A set of resource timing objects that are "valid" -- see "validEntryCriteria" */
+const scripts = new Set()
+/** @type {Array<{ test: (entry: PerformanceEntry) => boolean, addedAt: number }>} an array of PerformanceObserver subscribers to check for late emissions */
+let poSubscribers = []
+
+if (globalScope.PerformanceObserver?.supportedEntryTypes.includes('resource')) {
+  /** We must track the script assets this way, because the performance buffer can fill up and when it does that
+   * it stops accepting new entries (instead of dropping old entries), which means if the register API is called
+   * after the buffer fills up we won't be able to get the script timing information from the resource timing API
+  */
+  const scriptObserver = new PerformanceObserver((list) => {
+    list.getEntries().forEach((entry) => {
+      if (validEntryCriteria(entry)) {
+        if (scripts.size > 250) scripts.delete(scripts.values().next().value) // keep the set from growing indefinitely, we only need to check recent entries against the stack of the register API caller, so we can drop old entries as new ones come in
+        scripts.add(entry)
+        const canClear = []
+        poSubscribers.forEach(({ test, addedAt }, idx) => {
+          if (test(entry) || now() - addedAt > 10000) canClear.push(idx) // Clear subscribers that have resolved or have been pending for more than 10 seconds
+        })
+        poSubscribers = poSubscribers.filter((_, idx) => !canClear.includes(idx))
+      }
+    })
+  })
+  scriptObserver.observe({ type: 'resource', buffered: true })
+}
+
 /**
  * Extracts URLs from stack traces using the same logic as compute-stack-trace.js
  * @param {string} stack The error stack trace
@@ -45,29 +79,89 @@ function getDeepStackTrace () {
   return stack
 }
 
+/**
+ * Indicates whether the provided URL matches any script preload link tags in the document.
+ * @param {string} targetUrl The URL to match against preload tags
+ * @returns {boolean} True if a matching preload link is found, false otherwise
+ */
+function wasPreloaded (targetUrl) {
+  if (!targetUrl || !globalScope.document) return false
+
+  try {
+    const linkTags = globalScope.document.querySelectorAll('link[rel="preload"][as="script"]')
+    for (const link of linkTags) {
+      // link.href is resolved to an absolute URL by the browser (even if supplied as relative), so we can match exactly against the cleaned target URL
+      if (cleanURL(link.href) === targetUrl) return true
+    }
+  } catch (error) {
+    // Don't let DOM parsing errors break anything
+  }
+  return false
+}
+
 /**
  * Uses the stack of the initiator function, returns script timing information if a script can be found with the resource timing API matching the URL found in the stack.
- * @returns {{fetchStart: number, fetchEnd: number, asset: string|undefined}} Object containing script fetch start and end times, and the asset URL if found
+ * @returns {RegisterAPITimings} Object containing script fetch start and end times, and the asset URL if found
  */
 export function findScriptTimings () {
+  const timings = { registeredAt: now(), reportedAt: undefined, fetchStart: 0, fetchEnd: 0, asset: undefined, type: 'unknown' }
   const stack = getDeepStackTrace()
-  const timings = { fetchStart: 0, fetchEnd: 0, asset: undefined }
-  const scripts = globalScope.performance?.getEntriesByType('resource').filter(entry => entry.initiatorType === 'script') || []
-  if (scripts.length < 1 || !stack) return timings
+  if (!stack) return timings
+  const navUrl = globalScope.performance?.getEntriesByType('navigation')?.find(entry => entry.initiatorType === 'navigation')?.name || ''
 
   try {
     const mfeScriptUrl = extractUrlsFromStack(stack).at(-1) // array of URLs from the stack of the register API caller, the MFE script should be at the bottom
     if (!mfeScriptUrl) return timings
-    const match = scripts.find(script => {
-      const scriptUrl = cleanURL(script.name)
-      // Try exact match, then partial matches for different URL formats
-      return mfeScriptUrl === scriptUrl || mfeScriptUrl.endsWith(scriptUrl) || scriptUrl.endsWith(mfeScriptUrl)
-    })
+    if (navUrl.includes(mfeScriptUrl)) {
+      // this means the stack is indicating that the registration came from an inline script or eval, so we won't find a matching script resource - return early with just the URL
+      timings.asset = cleanURL(navUrl)
+      timings.type = 'inline'
+      return timings
+    }
+
+    // try to find it in the static list, which updates faster than the PO.  This cant be solely trusted, since the buffer can fill up and stop accepting entries,
+    // but it can still help in cases where the check is made before the asset is emitted by the performance observer and the buffer is not full. Fallback to checking the PO
+    // entries that have been buffered as seen in the PO callback if its not found in the static list.
+    const match = performance.getEntriesByType('resource').find(entryMatchesMfe) || [...scripts].find(entryMatchesMfe)
+
+    if (match) { setMatchedAttributes(match) } else {
+      // We didnt find a match with the PO, nor a static lookup... check if its preloaded and if so, set basic fallbacks and try to associate with a later script entry if possible, this can happen if the preload is reported late in the PO observer callback
+      if (wasPreloaded(mfeScriptUrl)) {
+        timings.asset = mfeScriptUrl
+        timings.type = 'preload'
+        // wait for a late PO callback...  The timings object can be mutated after the fact since we return a pointer and not a cloned object
+        poSubscribers.push({
+          addedAt: now(),
+          test: (entry) => {
+            if (entryMatchesMfe(entry)) {
+              setMatchedAttributes(entry)
+              return true // return true so that we know to clear this callback from the pending list since we found our match, otherwise it will stay in the list and be called for future entries which is unnecessary after we found our match and can cause performance issues if there are a lot of future entries and pending callbacks
+            }
+            return false
+          }
+        })
+      }
+    }
+
+    /**
+     * A matcher function to determine if a performance entry corresponds to the MFE script based on URL matching. It checks if either the entry URL ends with the MFE script URL or vice versa, to account for potential differences in how URLs are represented in the stack trace versus the resource timing entries.
+     * @param {PerformanceResourceTiming} entry - The resource timing entry to compare to the MFE script
+     * @returns {boolean} True if we think the entry matches the MFE script, false otherwise
+     */
+    function entryMatchesMfe (entry) {
+      const entryUrl = cleanURL(entry.name)
+      return entryUrl.endsWith(mfeScriptUrl) || mfeScriptUrl.endsWith(entryUrl)
+    }
 
-    if (match) {
-      timings.fetchStart = Math.floor(match.startTime)
-      timings.fetchEnd = Math.floor(match.responseEnd)
-      timings.asset = match.name
+    /**
+     * A helper function to set the matched timing attributes on the timings object based on a performance entry. This is called when we have identified a resource timing entry that we believe corresponds to the MFE script, and we want to extract the fetch start and end times, as well as the asset URL and type.
+     * @param {PerformanceResourceTiming} entry - The resource timing entry to base values off of
+     */
+    function setMatchedAttributes (entry) {
+      timings.fetchStart = Math.floor(entry.startTime)
+      timings.fetchEnd = Math.floor(entry.responseEnd)
+      timings.asset = entry.name
+      timings.type = entry.initiatorType
     }
   } catch (error) {
     // Don't let stack parsing errors break anything

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

@@ -30,19 +30,27 @@
 /**
  * @typedef {Object} RegisterAPIMetadata
  * @property {Object} customAttributes - The custom attributes for the registered entity.
- * @property {Object} timings - The timing metrics for the registered entity.
- * @property {number} timings.registeredAt - The timestamp when the registered entity was created.
- * @property {number} [timings.reportedAt] - The timestamp when the registered entity was deregistered.
- * @property {number} timings.fetchStart - The timestamp when the registered entity began fetching.
- * @property {number} timings.fetchEnd - The timestamp when the registered entity finished fetching.
- * @property {Object} [timings.asset] - The asset path (if found) for the registered entity.
- * @property {Object} target - The options for the registered entity.
- * @property {string} [target.licenseKey] - The license key for the registered entity. If none was supplied, it will assume the license key from the main agent.
- * @property {string} target.id - The ID for the registered entity.
- * @property {string} target.name - The name returned for the registered entity.
- * @property {{[key: string]: any}} [target.tags] - The tags for the registered entity as key-value pairs.
- * @property {string} [target.parentId] - The parentId for the registered entity. If none was supplied, it will assume the entity guid from the main agent.
- * @property {boolean} [target.isolated] - When true, each registration creates an isolated instance. When false, multiple registrations with the same id and isolated: false will share a single instance, including all custom attributes, ids, names, and metadata. Calling deregister on a shared instance will deregister it for all entities using the instance. Defaults to true.
+ * @property {RegisterAPITimings} timings - The timing metrics for the registered entity.
+ * @property {RegisterAPITarget} target - The options for the registered entity.
+ */
+
+/**
+ * @typedef {Object} RegisterAPITarget
+ * @property {string} id - The ID for the registered entity.
+ * @property {string} name - The name returned for the registered entity.
+ * @property {{[key: string]: any}} [tags] - The tags for the registered entity as key-value pairs.
+ * @property {string} [parentId] - The parentId for the registered entity. If none was supplied, it will assume the entity guid from the main agent.
+ * @property {boolean} [isolated] - When true, each registration creates an isolated instance. When false, multiple registrations with the same id and isolated: false will share a single instance, including all custom attributes, ids, names, and metadata. Calling deregister on a shared instance will deregister it for all entities using the instance. Defaults to true.
+ */
+
+/**
+ * @typedef {Object} RegisterAPITimings
+ * @property {number} registeredAt - The timestamp when the registered entity was created.
+ * @property {number} [reportedAt] - The timestamp when the registered entity was deregistered.
+ * @property {number} fetchStart - The timestamp when the registered entity began fetching.
+ * @property {number} fetchEnd - The timestamp when the registered entity finished fetching.
+ * @property {Object} [asset] - The asset path (if found) for the registered entity.
+ * @property {string} type - The type of timing associated with the registered entity, 'script' or 'link' if found with the performance resource API, 'inline' if found to be associated with the root document URL, or 'unknown' if no associated resource could be found.
  */
 
 export default {}

package/src/loaders/api/register.js

@@ -54,11 +54,7 @@ function register (agentRef, target, parent) {
   target.parent = parent || {}
   if (typeof target.tags !== 'object' || target.tags === null || Array.isArray(target.tags)) target.tags = {}
 
-  const timings = {
-    registeredAt: now(),
-    reportedAt: undefined,
-    ...findScriptTimings()
-  }
+  const timings = findScriptTimings()
 
   const attrs = {}
 
@@ -148,6 +144,8 @@ function register (agentRef, target, parent) {
     if (timings.reportedAt) return
     timings.reportedAt = now()
     api.recordCustomEvent('MicroFrontEndTiming', {
+      assetUrl: timings.asset, // the url of the script that was registered, or undefined if it could not be determined (inline or no match)
+      assetType: timings.type, // the type of asset that was associated with the timings, one of 'script', 'link' (if preloaded and found in the resource timing buffer), 'preload' (if preloaded but not found in the resource timing buffer), or "unknown" if it could not be determined
       timeToLoad: timings.registeredAt - timings.fetchStart, // fetchStart to registeredAt
       timeToBeRequested: timings.fetchStart, // origin to fetchStart
       timeToFetch: timings.fetchEnd - timings.fetchStart, // fetchStart to fetchEnd