@newrelic/browser-agent 1.273.0 → 1.273.1

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

@@ -1,6 +1,3 @@
-import { getInfo } from '../../common/config/info'
-import { getConfiguration } from '../../common/config/init'
-import { getRuntime } from '../../common/config/runtime'
 import { drain } from '../../common/drain/drain'
 import { ee } from '../../common/event-emitter/contextual-ee'
 import { registerHandler } from '../../common/event-emitter/register-handler'
@@ -8,15 +5,13 @@ import { SessionEntity } from '../../common/session/session-entity'
 import { LocalStorage } from '../../common/storage/local-storage.js'
 import { DEFAULT_KEY } from '../../common/session/constants'
 
-let ranOnce = 0
-export function setupAgentSession (agentIdentifier) {
-  const agentRuntime = getRuntime(agentIdentifier)
-  if (ranOnce++) return agentRuntime.session
+export function setupAgentSession (agentRef) {
+  if (agentRef.runtime.session) return agentRef.runtime.session // already setup
 
-  const sessionInit = getConfiguration(agentIdentifier).session
+  const sessionInit = agentRef.init.session
 
-  agentRuntime.session = new SessionEntity({
-    agentIdentifier,
+  agentRef.runtime.session = new SessionEntity({
+    agentIdentifier: agentRef.agentIdentifier,
     key: DEFAULT_KEY,
     storage: new LocalStorage(),
     expiresMs: sessionInit?.expiresMs,
@@ -24,29 +19,28 @@ export function setupAgentSession (agentIdentifier) {
   })
 
   // Retrieve & re-add all of the persisted setCustomAttribute|setUserId k-v from previous page load(s), if any was stored.
-  const customSessionData = agentRuntime.session.state.custom
-  const agentInfo = getInfo(agentIdentifier)
+  const customSessionData = agentRef.runtime.session.state.custom
   if (customSessionData) {
-    agentInfo.jsAttributes = { ...agentInfo.jsAttributes, ...customSessionData }
+    agentRef.info.jsAttributes = { ...agentRef.info.jsAttributes, ...customSessionData }
   }
 
-  const sharedEE = ee.get(agentIdentifier)
+  const sharedEE = ee.get(agentRef.agentIdentifier)
 
   // any calls to newrelic.setCustomAttribute(<persisted>) will need to be added to:
   // local info.jsAttributes {}
   // the session's storage API
   registerHandler('api-setCustomAttribute', (time, key, value) => {
-    agentRuntime.session.syncCustomAttribute(key, value)
+    agentRef.runtime.session.syncCustomAttribute(key, value)
   }, 'session', sharedEE)
 
   // any calls to newrelic.setUserId(...) will need to be added to:
   // local info.jsAttributes {}
   // the session's storage API
   registerHandler('api-setUserId', (time, key, value) => {
-    agentRuntime.session.syncCustomAttribute(key, value)
+    agentRef.runtime.session.syncCustomAttribute(key, value)
   }, 'session', sharedEE)
 
-  drain(agentIdentifier, 'session')
+  drain(agentRef.agentIdentifier, 'session')
 
-  return agentRuntime.session
+  return agentRef.runtime.session
 }

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

@@ -82,7 +82,7 @@ export class InstrumentBase extends FeatureBase {
       try {
         if (canEnableSessionTracking(this.agentIdentifier)) { // would require some setup before certain features start
           const { setupAgentSession } = await import(/* webpackChunkName: "session-manager" */ './agent-session')
-          session = setupAgentSession(this.agentIdentifier)
+          session = setupAgentSession(agentRef)
         }
       } catch (e) {
         warn(20, e)

package/src/loaders/agent-base.js

@@ -2,19 +2,13 @@
 
 import { warn } from '../common/util/console'
 import { SR_EVENT_EMITTER_TYPES } from '../features/session_replay/constants'
-import { generateRandomHexString } from '../common/ids/unique-id'
+import { MicroAgentBase } from './micro-agent-base'
 
 /**
  * @typedef {import('./api/interaction-types').InteractionInstance} InteractionInstance
  */
 
-export class AgentBase {
-  agentIdentifier
-
-  constructor (agentIdentifier = generateRandomHexString(16)) {
-    this.agentIdentifier = agentIdentifier
-  }
-
+export class AgentBase extends MicroAgentBase {
   /**
    * Tries to execute the api and generates a generic warning message with the api name injected if unsuccessful
    * @param {string} methodName
@@ -26,74 +20,11 @@ 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) {
-    return this.#callMethod('addPageAction', name, attributes)
-  }
-
-  /**
-   * 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) {
-    return this.#callMethod('setPageViewName', name, host)
-  }
-
-  /**
-   * 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|boolean|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, Integers and Booleans. Passing a null value unsets any existing attribute of the same name.
-   * @param {boolean} [persist] Default false. If 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) {
-    return this.#callMethod('setCustomAttribute', name, value, persist)
-  }
-
-  /**
-   * 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) {
-    return this.#callMethod('noticeError', error, customAttributes)
-  }
-
-  /**
-   * 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) {
-    return this.#callMethod('setUserId', value)
-  }
-
-  /**
-   * Adds a user-defined application version string to subsequent events on the page.
-   * This decorates all payloads with an attribute of `application.version` which is queryable in NR1.
-   * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/setapplicationversion/}
-   * @param {string|null} value A string identifier for the application version, useful for
-   * tying all browser events to a specific release tag. The value parameter does not
-   * have to be unique. Passing a null value unsets any existing value.
-   */
-  setApplicationVersion (value) {
-    return this.#callMethod('setApplicationVersion', value)
-  }
-
-  /**
-   * 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.
+   * Starts any and all features that are not running yet in "autoStart" mode
+   * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/start/}
    */
-  setErrorHandler (callback) {
-    return this.#callMethod('setErrorHandler', callback)
+  start () {
+    return this.#callMethod('start')
   }
 
   /**
@@ -105,25 +36,6 @@ export class AgentBase {
     return this.#callMethod('finished', timeStamp)
   }
 
-  /**
-   * 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) {
-    return this.#callMethod('addRelease', name, id)
-  }
-
-  /**
-   * Starts a set of agent features if not running in "autoStart" mode
-   * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/start/}
-   * @param {string|string[]} [featureNames] The name(s) of the features to start.  If no name(s) are passed, all features will be started
-   */
-  start (featureNames) {
-    return this.#callMethod('start', featureNames)
-  }
-
   /**
    * Forces a replay to record. If a replay is already actively recording, this call will be ignored.
    * If a recording has not been started, a new one will be created. If a recording has been started, but is currently not recording, it will resume recording.
@@ -179,16 +91,6 @@ export class AgentBase {
     return this.#callMethod('interaction')
   }
 
-  /**
-   * Capture a single log.
-   * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/log/}
-   * @param {string} message String to be captured as log message
-   * @param {{customAttributes?: object, level?: 'ERROR'|'TRACE'|'DEBUG'|'INFO'|'WARN'}} [options] customAttributes defaults to `{}` if not assigned, level defaults to `info` if not assigned.
-  */
-  log (message, options) {
-    return this.#callMethod('log', message, options)
-  }
-
   /**
    * Wrap a logger function to capture a log each time the function is invoked with the message and arguments passed
    * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/wraplogger/}

package/src/loaders/micro-agent-base.js

@@ -0,0 +1,113 @@
+import { warn } from '../common/util/console'
+import { generateRandomHexString } from '../common/ids/unique-id'
+
+export class MicroAgentBase {
+  agentIdentifier
+
+  constructor (agentIdentifier = generateRandomHexString(16)) {
+    this.agentIdentifier = agentIdentifier
+  }
+
+  /**
+   * Tries to execute the api and generates a generic warning message with the api name injected if unsuccessful
+   * @param {string} methodName
+   * @param  {...any} args
+   */
+  #callMethod (methodName, ...args) {
+    if (typeof this.api?.[methodName] !== 'function') warn(35, methodName)
+    else return this.api[methodName](...args)
+  }
+
+  // MicroAgent class custom defines its own start
+
+  /**
+   * 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) {
+    return this.#callMethod('addPageAction', name, attributes)
+  }
+
+  /**
+   * 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) {
+    return this.#callMethod('setPageViewName', name, host)
+  }
+
+  /**
+   * 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|boolean|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, Integers and Booleans. Passing a null value unsets any existing attribute of the same name.
+   * @param {boolean} [persist] Default false. If 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) {
+    return this.#callMethod('setCustomAttribute', name, value, persist)
+  }
+
+  /**
+   * 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) {
+    return this.#callMethod('noticeError', error, customAttributes)
+  }
+
+  /**
+   * 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) {
+    return this.#callMethod('setUserId', value)
+  }
+
+  /**
+   * Adds a user-defined application version string to subsequent events on the page.
+   * This decorates all payloads with an attribute of `application.version` which is queryable in NR1.
+   * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/setapplicationversion/}
+   * @param {string|null} value A string identifier for the application version, useful for
+   * tying all browser events to a specific release tag. The value parameter does not
+   * have to be unique. Passing a null value unsets any existing value.
+   */
+  setApplicationVersion (value) {
+    return this.#callMethod('setApplicationVersion', value)
+  }
+
+  /**
+   * 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) {
+    return this.#callMethod('setErrorHandler', callback)
+  }
+
+  /**
+   * 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) {
+    return this.#callMethod('addRelease', name, id)
+  }
+
+  /**
+   * Capture a single log.
+   * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/log/}
+   * @param {string} message String to be captured as log message
+   * @param {{customAttributes?: object, level?: 'ERROR'|'TRACE'|'DEBUG'|'INFO'|'WARN'}} [options] customAttributes defaults to `{}` if not assigned, level defaults to `info` if not assigned.
+  */
+  log (message, options) {
+    return this.#callMethod('log', message, options)
+  }
+}

package/src/loaders/micro-agent.js

@@ -4,13 +4,9 @@ import { getEnabledFeatures } from './features/enabled-features'
 import { configure } from './configure/configure'
 // core files
 import { setNREUMInitializedAgent } from '../common/window/nreum'
-import { getInfo } from '../common/config/info'
-import { getConfiguration, getConfigurationValue } from '../common/config/init'
-import { getLoaderConfig } from '../common/config/loader-config'
-import { getRuntime } from '../common/config/runtime'
 import { FEATURE_NAMES } from './features/features'
 import { warn } from '../common/util/console'
-import { AgentBase } from './agent-base'
+import { MicroAgentBase } from './micro-agent-base'
 
 const nonAutoFeatures = [
   FEATURE_NAMES.jserrors,
@@ -24,7 +20,7 @@ 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 extends AgentBase {
+export class MicroAgent extends MicroAgentBase {
   /**
    * @param {Object} options - Specifies features and runtime configuration,
    * @param {string=} agentIdentifier - The optional unique ID of the agent.
@@ -41,62 +37,53 @@ export class MicroAgent extends AgentBase {
     /**
      * Starts a set of agent features if not running in "autoStart" mode
      * {@link https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/start/}
-     * @param {string|string[]|undefined} name The feature name(s) to start.  If no name(s) are passed, all features will be started
+     * @param {string|string[]} [featureNames] The feature name(s) to start.  If no name(s) are passed, all features will be started
      */
-    this.start = features => this.run(features)
-    this.run(nonAutoFeatures.filter(featureName => getConfigurationValue(this.agentIdentifier, `${featureName}.autoStart`)))
-  }
-
-  get config () {
-    return {
-      info: getInfo(this.agentIdentifier),
-      init: getConfiguration(this.agentIdentifier),
-      loader_config: getLoaderConfig(this.agentIdentifier),
-      runtime: getRuntime(this.agentIdentifier)
-    }
-  }
+    this.start = (featureNames) => {
+      try {
+        if (featureNames === undefined || (Array.isArray(featureNames) && featureNames.length === 0)) featureNames = nonAutoFeatures
+        else if (typeof featureNames === 'string') featureNames = [featureNames]
 
-  run (features) {
-    try {
-      const featNames = nonAutoFeatures
-      if (features === undefined) features = featNames
-      else {
-        features = Array.isArray(features) && features.length ? features : [features]
-        if (features.some(f => !featNames.includes(f))) return warn(37, featNames)
-        if (!features.includes(FEATURE_NAMES.pageViewEvent)) features.push(FEATURE_NAMES.pageViewEvent)
-      }
-    } catch (err) {
-      warn(23, err)
-    }
+        if (featureNames.some(f => !nonAutoFeatures.includes(f))) warn(37, nonAutoFeatures)
+        const enabledFeatures = getEnabledFeatures(this.agentIdentifier)
 
-    try {
-      const enabledFeatures = getEnabledFeatures(this.agentIdentifier)
+        try {
+          // a biproduct of doing this is that the "session manager" is automatically handled through importing this feature
+          this.features.page_view_event = new PVE(this)
+        } catch (err) {
+          warn(24, err)
+        }
 
-      try {
-        // a biproduct of doing this is that the "session manager" is automatically handled through importing this feature
-        this.features.page_view_event = new PVE(this)
+        this.features.page_view_event.onAggregateImported.then(() => {
+          /* The following features do not import an "instrument" file, meaning they are only hooked up to the API.
+          Since the missing instrument-base class handles drain-gating (racing behavior) and PVE handles some setup, these are chained until after PVE has finished initializing
+          so as to avoid the race condition of things like session and sharedAggregator not being ready by features that uses them right away. */
+          nonAutoFeatures.forEach(f => {
+            if (enabledFeatures[f] && featureNames.includes(f)) {
+              import(/* webpackChunkName: "lazy-feature-loader" */ '../features/utils/lazy-feature-loader').then(({ lazyFeatureLoader }) => {
+                return lazyFeatureLoader(f, 'aggregate')
+              }).then(({ Aggregate }) => {
+                this.features[f] = new Aggregate(this)
+              }).catch(err => warn(25, err))
+            }
+          })
+        })
+        return true
       } catch (err) {
-        warn(24, err)
+        warn(26, err)
+        return false
       }
+    }
 
-      this.features.page_view_event.onAggregateImported.then(() => {
-        /* The following features do not import an "instrument" file, meaning they are only hooked up to the API.
-        Since the missing instrument-base class handles drain-gating (racing behavior) and PVE handles some setup, these are chained until after PVE has finished initializing
-        so as to avoid the race condition of things like session and sharedAggregator not being ready by features that uses them right away. */
-        nonAutoFeatures.forEach(f => {
-          if (enabledFeatures[f] && features.includes(f)) {
-            import(/* webpackChunkName: "lazy-feature-loader" */ '../features/utils/lazy-feature-loader').then(({ lazyFeatureLoader }) => {
-              return lazyFeatureLoader(f, 'aggregate')
-            }).then(({ Aggregate }) => {
-              this.features[f] = new Aggregate(this)
-            }).catch(err => warn(25, err))
-          }
-        })
-      })
-      return true
-    } catch (err) {
-      warn(26, err)
-      return false
+    this.start(nonAutoFeatures.filter(featureName => !!this.init[featureName].autoStart))
+  }
+
+  get config () {
+    return {
+      info: this.info,
+      init: this.init,
+      loader_config: this.loader_config,
+      runtime: this.runtime
     }
   }
 }