@newrelic/browser-agent 1.302.0-rc.7 → 1.302.0-rc.9

package/src/features/utils/agent-session.js

@@ -56,6 +56,18 @@ export function setupAgentSession (agentRef) {
     agentRef.runtime.session.syncCustomAttribute(key, value)
   }, 'session', sharedEE)
 
+  registerHandler('api-consent', (accept) => {
+    agentRef.runtime.session.write({ consent: accept === undefined ? true : accept })
+
+    // call sendRum if it wasn't called yet
+    agentRef.features.page_view_event.onAggregateImported.then((loaded) => {
+      const pveAgg = agentRef.features.page_view_event.featAggregate
+      if (loaded && !pveAgg.sentRum) {
+        pveAgg.sendRum()
+      }
+    })
+  }, 'session', sharedEE)
+
   drain(agentRef.agentIdentifier, 'session')
 
   return agentRef.runtime.session

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

@@ -49,7 +49,10 @@ export class InstrumentBase extends FeatureBase {
      * @type {Promise} Assigned immediately after @see importAggregator runs. Serves as a signal for when the inner async fn finishes execution. Useful for features to await
      * one another if there are inter-features dependencies.
     */
-    this.onAggregateImported = undefined
+    this.loadedSuccessfully = undefined
+    this.onAggregateImported = new Promise(resolve => {
+      this.loadedSuccessfully = resolve
+    })
 
     /**
      * used in conjunction with newrelic.start() to defer harvesting in features
@@ -83,11 +86,6 @@ export class InstrumentBase extends FeatureBase {
   importAggregator (agentRef, fetchAggregator, argsObjFromInstrument = {}) {
     if (this.featAggregate) return
 
-    let loadedSuccessfully
-    this.onAggregateImported = new Promise(resolve => {
-      loadedSuccessfully = resolve
-    })
-
     const importLater = async () => {
       // wait for the deferred promise to resolve before proceeding
       // this will resolve immediately if the feature is auto-started,
@@ -113,20 +111,20 @@ export class InstrumentBase extends FeatureBase {
       try {
         if (!this.#shouldImportAgg(this.featureName, session, agentRef.init)) {
           drain(this.agentIdentifier, this.featureName)
-          loadedSuccessfully(false) // aggregate module isn't loaded at all
+          this.loadedSuccessfully(false) // aggregate module isn't loaded at all
           return
         }
         const { Aggregate } = await fetchAggregator()
         this.featAggregate = new Aggregate(agentRef, argsObjFromInstrument)
 
         agentRef.runtime.harvester.initializedAggregates.push(this.featAggregate) // "subscribe" the feature to future harvest intervals (PVE will start the timer)
-        loadedSuccessfully(true)
+        this.loadedSuccessfully(true)
       } catch (e) {
         warn(34, e)
         this.abortHandler?.() // undo any important alterations made to the page
         // not supported yet but nice to do: "abort" this agent's EE for this feature specifically
         drain(this.agentIdentifier, this.featureName, true)
-        loadedSuccessfully(false)
+        this.loadedSuccessfully(false)
         if (this.ee) this.ee.abort()
       }
     }

package/src/interfaces/registered-entity.js

@@ -58,6 +58,17 @@ export class RegisteredEntity {
     warn(35, 'recordCustomEvent')
   }
 
+  /**
+   * Measures a task that is recorded as a BrowserPerformance event.
+   * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/measure/}
+   * @param {string} name The name of the task
+   * @param {{start: number, end: number, duration: number, customAttributes: object}} [options] An object used to control the way the measure API operates
+   * @returns {{start: number, end: number, duration: number, customAttributes: object}} Measurement details
+   */
+  measure (name, options) {
+    warn(35, 'measure')
+  }
+
   /**
    * Adds a user-defined attribute name and value to subsequent events on the page for the registered target. Note -- the persist flag does not work with the register API.
    * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/setcustomattribute/}

package/src/loaders/agent.js

@@ -23,6 +23,7 @@ import { setupSetCustomAttributeAPI } from './api/setCustomAttribute'
 import { setupSetUserIdAPI } from './api/setUserId'
 import { setupSetApplicationVersionAPI } from './api/setApplicationVersion'
 import { setupStartAPI } from './api/start'
+import { setupConsentAPI } from './api/consent'
 
 /**
  * @typedef {Object} AgentOptions
@@ -70,6 +71,7 @@ export class Agent extends AgentBase {
     setupSetUserIdAPI(this)
     setupSetApplicationVersionAPI(this)
     setupStartAPI(this)
+    setupConsentAPI(this)
 
     this.run()
   }

package/src/loaders/api/consent.js

@@ -0,0 +1,18 @@
+/**
+ * Copyright 2020-2025 New Relic, Inc. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { prefix, CONSENT } from './constants'
+import { setupAPI } from './sharedHandlers'
+import { handle } from '../../common/event-emitter/handle'
+import { warn } from '../../common/util/console'
+
+export function setupConsentAPI (agent) {
+  setupAPI(CONSENT, function (accept) {
+    if (accept !== undefined && typeof accept !== 'boolean') {
+      warn(65, typeof accept)
+      return
+    }
+    handle(prefix + CONSENT, [accept], undefined, 'session', agent.ee)
+  }, agent)
+}

package/src/loaders/api/constants.js

@@ -25,3 +25,4 @@ export const SET_USER_ID = 'setUserId'
 export const START = 'start'
 export const WRAP_LOGGER = 'wrapLogger'
 export const MEASURE = 'measure'
+export const CONSENT = 'consent'

package/src/loaders/api/measure.js

@@ -10,44 +10,45 @@ import { prefix, MEASURE } from './constants'
 import { setupAPI } from './sharedHandlers'
 
 export function setupMeasureAPI (agent) {
-  setupAPI(MEASURE, function (name, options) {
-    const n = now()
-    const { start, end, customAttributes } = options || {}
-    const returnObj = { customAttributes: customAttributes || {} }
+  setupAPI(MEASURE, (name, options) => measure(name, options, agent), agent)
+}
+
+export function measure (name, options, agentRef, target, timestamp = now()) {
+  const { start, end, customAttributes } = options || {}
+  const returnObj = { customAttributes: customAttributes || {} }
 
-    if (typeof returnObj.customAttributes !== 'object' || typeof name !== 'string' || name.length === 0) {
-      warn(57)
-      return
-    }
+  if (typeof returnObj.customAttributes !== 'object' || typeof name !== 'string' || name.length === 0) {
+    warn(57)
+    return
+  }
 
-    /**
+  /**
      * getValueFromTiming - Helper function to extract a numeric value from a supplied option.
      * @param {Number|PerformanceMark} [timing] The timing value
      * @param {Number} [d] The default value to return if timing is invalid
      * @returns {Number} The timing value or the default value
      */
-    const getValueFromTiming = (timing, d) => {
-      if (timing == null) return d
-      if (typeof timing === 'number') return timing
-      if (timing instanceof PerformanceMark) return timing.startTime
-      return Number.NaN
-    }
-
-    returnObj.start = getValueFromTiming(start, 0)
-    returnObj.end = getValueFromTiming(end, n)
-    if (Number.isNaN(returnObj.start) || Number.isNaN(returnObj.end)) {
-      warn(57)
-      return
-    }
-
-    returnObj.duration = returnObj.end - returnObj.start
-    if (returnObj.duration < 0) {
-      warn(58)
-      return
-    }
-
-    handle(prefix + MEASURE, [returnObj, name], undefined, FEATURE_NAMES.genericEvents, agent.ee)
-
-    return returnObj
-  }, agent)
+  const getValueFromTiming = (timing, d) => {
+    if (timing == null) return d
+    if (typeof timing === 'number') return timing
+    if (timing instanceof PerformanceMark) return timing.startTime
+    return Number.NaN
+  }
+
+  returnObj.start = getValueFromTiming(start, 0)
+  returnObj.end = getValueFromTiming(end, timestamp)
+  if (Number.isNaN(returnObj.start) || Number.isNaN(returnObj.end)) {
+    warn(57)
+    return
+  }
+
+  returnObj.duration = returnObj.end - returnObj.start
+  if (returnObj.duration < 0) {
+    warn(58)
+    return
+  }
+
+  handle(prefix + MEASURE, [returnObj, name, target], undefined, FEATURE_NAMES.genericEvents, agentRef.ee)
+
+  return returnObj
 }

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

@@ -9,6 +9,7 @@
  * @property {(message: string, options?: { customAttributes?: object, level?: 'ERROR' | 'TRACE' | 'DEBUG' | 'INFO' | 'WARN'}) => void} log - Capture a log for the registered entity.
  * @property {(error: Error | string, customAttributes?: object) => void} noticeError - Notice an error for the registered entity.
  * @property {(eventType: string, attributes?: Object) => void} recordCustomEvent - Record a custom event for the registered entity.
+ * @property {(eventType: string, options?: {start: number, end: number, duration: number, customAttributes: object}) => {{start: number, end: number, duration: number, customAttributes: object}}} measure - Measures a task that is recorded as a BrowserPerformance event.
  * @property {(value: string | null) => void} setApplicationVersion - Add an application.version attribute to all outgoing data for the registered entity.
  * @property {(name: string, value: string | number | boolean | null, persist?: boolean) => void} setCustomAttribute - Add a custom attribute to outgoing data for the registered entity.
  * @property {(value: string | null) => void} setUserId - Add an enduser.id attribute to all outgoing API data for the registered entity.

package/src/loaders/api/register.js

@@ -14,6 +14,7 @@ import { log } from './log'
 import { addPageAction } from './addPageAction'
 import { noticeError } from './noticeError'
 import { single } from '../../common/util/invoke'
+import { measure } from './measure'
 import { recordCustomEvent } from './recordCustomEvent'
 
 /**
@@ -79,6 +80,7 @@ export function buildRegisterApi (agentRef, target) {
   const api = {
     addPageAction: (name, attributes = {}) => report(addPageAction, [name, { ...attrs, ...attributes }, agentRef], target),
     log: (message, options = {}) => report(log, [message, { ...options, customAttributes: { ...attrs, ...(options.customAttributes || {}) } }, agentRef], target),
+    measure: (name, options = {}) => report(measure, [name, { ...options, customAttributes: { ...attrs, ...(options.customAttributes || {}) } }, agentRef], target),
     noticeError: (error, attributes = {}) => report(noticeError, [error, { ...attrs, ...attributes }, agentRef], target),
     recordCustomEvent: (eventType, attributes = {}) => report(recordCustomEvent, [eventType, { ...attrs, ...attributes }, agentRef], target),
     setApplicationVersion: (value) => setLocalValue('application.version', value),

package/src/loaders/api-base.js

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import { warn } from '../common/util/console'
-import { ADD_PAGE_ACTION, ADD_RELEASE, ADD_TO_TRACE, FINISHED, INTERACTION, LOG, NOTICE_ERROR, PAUSE_REPLAY, RECORD_CUSTOM_EVENT, RECORD_REPLAY, REGISTER, SET_APPLICATION_VERSION, SET_CURRENT_ROUTE_NAME, SET_CUSTOM_ATTRIBUTE, SET_ERROR_HANDLER, SET_PAGE_VIEW_NAME, SET_USER_ID, START, WRAP_LOGGER, MEASURE } from './api/constants'
+import { ADD_PAGE_ACTION, ADD_RELEASE, ADD_TO_TRACE, CONSENT, FINISHED, INTERACTION, LOG, NOTICE_ERROR, PAUSE_REPLAY, RECORD_CUSTOM_EVENT, RECORD_REPLAY, REGISTER, SET_APPLICATION_VERSION, SET_CURRENT_ROUTE_NAME, SET_CUSTOM_ATTRIBUTE, SET_ERROR_HANDLER, SET_PAGE_VIEW_NAME, SET_USER_ID, START, WRAP_LOGGER, MEASURE } from './api/constants'
 
 /**
  * @typedef {import('./api/interaction-types').InteractionInstance} InteractionInstance
@@ -219,10 +219,20 @@ export class ApiBase {
    * Measures a task that is recorded as a BrowserPerformance event.
    * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/measure/}
    * @param {string} name The name of the task
-   * @param {object?} options An object used to control the way the measure API operates
+   * @param {{start: number, end: number, duration: number, customAttributes: object}} [options] An object used to control the way the measure API operates
    * @returns {{start: number, end: number, duration: number, customAttributes: object}} Measurement details
    */
   measure (name, options) {
     return this.#callMethod(MEASURE, name, options)
   }
+
+  /**
+   * Accepts or rejects consent when the agent is configured to require consent before harvesting.
+   * The consent state is stored in session storage inside the NRBA_SESSION object.
+   * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/consent/}
+   * @param {boolean?} accept Whether to accept or reject consent. Defaults to true (accept) if left undefined.
+   */
+  consent (accept) {
+    return this.#callMethod(CONSENT, accept)
+  }
 }