npm - newrelic - Versions diffs - 9.7.5 → 9.8.0 - Mend

newrelic 9.7.5 → 9.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3) hide show

package/NEWS.md CHANGED Viewed

@@ -1,15 +1,26 @@
-### v9.7.5 (2023-01-03)
-* Added a check to the code level metrics utility to ensure filePath was set before adding the `code.*` attributes.
-* Updated to latest version of `@newrelic/test-utilities`
-* Fixed issue where listing of dependencies and packages from symlinked nested directories created an infinite loop which caused the agent to never connect.
-### v9.7.4 (2022-12-15)
-* Fixed system info gathering to prevent unhandled promise rejection when an error occurs reading `/proc` information.
+### v9.8.0 (2023-01-17)
+* Updated `getBrowserTimingHeader` to allow Browser Agent to be generated even when not in a Transaction by adding `allowTransactionlessInjection` to function options. `allowTransactionlessInjection` is a boolean option, and when set to `true`, will allow injection of the Browser Agent when not in a transaction. This is intended to be used in frameworks that build Static Site Generation(SSG). Note that if you are using this option, you may need to wait until the Node agent has established a connection before calling `getBrowserTimingHeader`. To wait until the agent is connected, you can add the following check to your code:
+```js
+if (!newrelic.agent.collector.isConnected()) {
+  await new Promise((resolve) => {
+    newrelic.agent.on('connected', resolve)
+  })
+}
+```
+### v9.7.5 (2023-01-03)
+* Added a check to the code level metrics utility to ensure filePath was set before adding the `code.*` attributes.
+* Updated to latest version of `@newrelic/test-utilities`
+* Fixed issue where listing of dependencies and packages from symlinked nested directories created an infinite loop which caused the agent to never connect.
+### v9.7.4 (2022-12-15)
+* Fixed system info gathering to prevent unhandled promise rejection when an error occurs reading `/proc` information.
 ### v9.7.3 (2022-12-12)
 * Added support for Code Level Metrics on API methods: `startSegment`, `startBackgroundTransaction`, and `startWebTransaction`.

package/api.js CHANGED Viewed

@@ -40,7 +40,7 @@ const RUM_STUB_SHELL_WITH_NONCE_PARAM = `<script type='text/javascript' %s>${RUM
 // these messages are used in the _gracefail() method below in getBrowserTimingHeader
 const RUM_ISSUES = [
   'NREUM: no browser monitoring headers generated; disabled',
-  'NREUM: transaction missing or ignored while generating browser monitoring headers',
+  'NREUM: transaction ignored while generating browser monitoring headers',
   'NREUM: config.browser_monitoring missing, something is probably wrong',
   'NREUM: browser_monitoring headers need a transaction name',
   'NREUM: browser_monitoring requires valid application_id',
@@ -640,144 +640,180 @@ function _generateRUMHeader(options = {}, metadata, loader) {
 }
 /**
- * Get the script header necessary for Browser Monitoring
- * This script must be manually injected into your templates, as high as possible
- * in the header, but _after_ any X-UA-COMPATIBLE HTTP-EQUIV meta tags.
- * Otherwise you may hurt IE!
- *
- * By default this method will return a script wrapped by `<script>` tags, but with
- * option `hasToRemoveScriptWrapper` it can send back only the script content
- * without the `<script>` wrapper. Useful for React component based frontend.
- *
- * This method must be called _during_ a transaction, and must be called every
- * time you want to generate the headers.
+ * Helper method for determining if we have the minimum required
+ * information to generate our Browser Agent script tag
  *
- * Do *not* reuse the headers between users, or even between requests.
- *
- * @param {object} options configuration options
- * @param {string} [options.nonce] - Nonce to inject into `<script>` header.
- * @param {boolean} [options.hasToRemoveScriptWrapper] - Used to import agent script without `<script>` tag wrapper.
- * @returns {string} The script content to be injected in `<head>` or put inside `<script>` tag (depending on options)
+ * @param {object} config agent configuration settings
+ * @param {Transaction} transaction the active transaction or null
+ * @param {boolean} allowTransactionlessInjection whether or not to allow the Browser Agent to be injected when there is no active transaction
+ * @returns {{ isValidConfig: boolean, failureIdx?: number, quietMode?: boolean }} object containing validation results
  */
-API.prototype.getBrowserTimingHeader = function getBrowserTimingHeader(options) {
-  const metric = this.agent.metrics.getOrCreateMetric(
-    NAMES.SUPPORTABILITY.API + '/getBrowserTimingHeader'
-  )
-  metric.incrementCallCount()
-  const config = this.agent.config
-  const browserMonitoring = config.browser_monitoring
-  // config.browser_monitoring should always exist, but we don't want the agent
-  // to bail here if something goes wrong
-  if (!browserMonitoring) {
-    return _gracefail(2)
+function validateBrowserMonitoring(config, transaction, allowTransactionlessInjection) {
+  /*
+   * config.browser_monitoring should always exist, but we don't want the agent
+   * to bail here if something goes wrong
+   */
+  if (!config.browser_monitoring) {
+    return { isValidConfig: false, failureIdx: 2 }
   }
-  /* Can control header generation with configuration this setting is only
+  /*
+   * Can control header generation with configuration this setting is only
    * available in the newrelic.js config file, it is not ever set by the
    * server.
    */
-  if (!browserMonitoring.enable) {
+  if (!config.browser_monitoring.enable) {
     // It has been disabled by the user; no need to warn them about their own
     // settings so fail quietly and gracefully.
-    return _gracefail(0, true)
-  }
-  const trans = this.agent.getTransaction()
-  // bail gracefully outside a transaction
-  if (!trans || trans.isIgnored()) {
-    return _gracefail(1)
+    return { isValidConfig: false, failureIdx: 0, quietMode: true }
   }
-  const name = trans.getFullName()
-  /* If we're in an unnamed transaction, add a friendly warning this is to
-   * avoid people going crazy, trying to figure out why browser monitoring is
-   * not working when they're missing a transaction name.
-   */
-  if (!name) {
-    return _gracefail(3)
-  }
-  const time = trans.timer.getDurationInMillis()
   /*
-   * Only the first 13 chars of the license should be used for hashing with
-   * the transaction name.
-   */
-  const key = config.license_key.substr(0, 13)
-  const appid = config.application_id
-  /* This is only going to work if the agent has successfully handshaked with
+   * This is only going to work if the agent has successfully handshaked with
    * the collector. If the networks is bad, or there is no license key set in
    * newrelic.js, there will be no application_id set.  We bail instead of
    * outputting null/undefined configuration values.
    */
-  if (!appid) {
-    return _gracefail(4)
+  if (!config.application_id) {
+    return { isValidConfig: false, failureIdx: 4 }
   }
-  /* If there is no browser_key, the server has likely decided to disable
+  /*
+   * If there is no browser_key, the server has likely decided to disable
    * browser monitoring.
    */
-  const licenseKey = browserMonitoring.browser_key
-  if (!licenseKey) {
-    return _gracefail(5)
+  if (!config.browser_monitoring.browser_key) {
+    return { isValidConfig: false, failureIdx: 5 }
   }
-  /* If there is no agent_loader script, there is no point
+  /*
+   * If there is no agent_loader script, there is no point
    * in setting the rum data
    */
-  const jsAgentLoader = browserMonitoring.js_agent_loader
-  if (!jsAgentLoader) {
-    return _gracefail(6)
+  if (!config.browser_monitoring.js_agent_loader) {
+    return { isValidConfig: false, failureIdx: 6 }
   }
-  /* If rum is enabled, but then later disabled on the server,
+  /*
+   * If rum is enabled, but then later disabled on the server,
    * this is the only parameter that gets updated.
    *
    * This condition should only be met if rum is disabled during
    * the lifetime of an application, and it should be picked up
    * on the next ForceRestart by the collector.
    */
-  const loader = browserMonitoring.loader
-  if (loader === 'none') {
-    return _gracefail(7)
+  if (config.browser_monitoring.loader === 'none') {
+    return { isValidConfig: false, failureIdx: 7 }
   }
+  if (!allowTransactionlessInjection && !transaction) {
+    return { isValidConfig: false, failureIdx: 1 }
+  }
+  return { isValidConfig: true }
+}
+/**
+ * Get the script header necessary for Browser Monitoring
+ * This script must be manually injected into your templates, as high as possible
+ * in the header, but _after_ any X-UA-COMPATIBLE HTTP-EQUIV meta tags.
+ * Otherwise you may hurt IE!
+ *
+ * By default this method will return a script wrapped by `<script>` tags, but with
+ * option `hasToRemoveScriptWrapper` it can send back only the script content
+ * without the `<script>` wrapper. Useful for React component based frontend.
+ *
+ * This method must be called every time you want to generate the headers.
+ *
+ * Do *not* reuse the headers between users, or even between requests.
+ *
+ * @param {object} options configuration options
+ * @param {string} [options.nonce] - Nonce to inject into `<script>` header.
+ * @param {boolean} [options.hasToRemoveScriptWrapper] - Used to import agent script without `<script>` tag wrapper.
+ * @param {options} [options.allowTransactionlessInjection] Whether or not to allow the Browser Agent to be injected when there is no active transaction
+ * @returns {string} The script content to be injected in `<head>` or put inside `<script>` tag (depending on options)
+ */
+API.prototype.getBrowserTimingHeader = function getBrowserTimingHeader(options = {}) {
+  const metric = this.agent.metrics.getOrCreateMetric(
+    NAMES.SUPPORTABILITY.API + '/getBrowserTimingHeader'
+  )
+  metric.incrementCallCount()
+  const trans = this.agent.getTransaction()
+  const { isValidConfig, failureIdx, quietMode } = validateBrowserMonitoring(
+    this.agent.config,
+    trans,
+    options.allowTransactionlessInjection
+  )
+  if (!isValidConfig) {
+    return _gracefail(failureIdx, quietMode)
+  }
+  const config = this.agent.config
   // This hash gets written directly into the browser.
   const rumHash = {
-    agent: browserMonitoring.js_agent_file,
-    beacon: browserMonitoring.beacon,
-    errorBeacon: browserMonitoring.error_beacon,
-    licenseKey: licenseKey,
-    applicationID: appid,
-    applicationTime: time,
-    transactionName: hashes.obfuscateNameUsingKey(name, key),
-    queueTime: trans.queueTime,
-    ttGuid: trans.id,
+    agent: config.browser_monitoring.js_agent_file,
+    beacon: config.browser_monitoring.beacon,
+    errorBeacon: config.browser_monitoring.error_beacon,
+    licenseKey: config.browser_monitoring.browser_key,
+    applicationID: config.application_id,
     // we don't use these parameters yet
     agentToken: null
   }
-  const attrs = Object.create(null)
+  const hasActiveTransaction = trans !== null
-  const customAttrs = trans.trace.custom.get(ATTR_DEST.BROWSER_EVENT)
-  if (!properties.isEmpty(customAttrs)) {
-    attrs.u = customAttrs
-  }
+  if (hasActiveTransaction) {
+    // bail gracefully outside an ignored transaction
+    if (trans.isIgnored()) {
+      return _gracefail(1)
+    }
-  const agentAttrs = trans.trace.attributes.get(ATTR_DEST.BROWSER_EVENT)
-  if (!properties.isEmpty(agentAttrs)) {
-    attrs.a = agentAttrs
-  }
+    /* If we're in an unnamed transaction, add a friendly warning this is to
+     * avoid people going crazy, trying to figure out why browser monitoring is
+     * not working when they're missing a transaction name.
+     */
+    const name = trans.getFullName()
+    if (!name) {
+      return _gracefail(3)
+    }
+    const time = trans.timer.getDurationInMillis()
+    rumHash.applicationTime = time
+    /*
+     * Only the first 13 chars of the license should be used for hashing with
+     * the transaction name.
+     */
+    const key = config.license_key.substr(0, 13)
+    rumHash.transactionName = hashes.obfuscateNameUsingKey(name, key)
-  if (!properties.isEmpty(attrs)) {
-    rumHash.atts = hashes.obfuscateNameUsingKey(JSON.stringify(attrs), key)
+    rumHash.queueTime = trans.queueTime
+    rumHash.ttGuid = trans.id
+    const attrs = Object.create(null)
+    const customAttrs = trans.trace.custom.get(ATTR_DEST.BROWSER_EVENT)
+    if (!properties.isEmpty(customAttrs)) {
+      attrs.u = customAttrs
+    }
+    const agentAttrs = trans.trace.attributes.get(ATTR_DEST.BROWSER_EVENT)
+    if (!properties.isEmpty(agentAttrs)) {
+      attrs.a = agentAttrs
+    }
+    if (!properties.isEmpty(attrs)) {
+      rumHash.atts = hashes.obfuscateNameUsingKey(JSON.stringify(attrs), key)
+    }
+  } else {
+    logger.debug(
+      'No transaction detected when generating RUM header, continuing without transaction info'
+    )
   }
   // if debugging, do pretty format of JSON
@@ -785,7 +821,11 @@ API.prototype.getBrowserTimingHeader = function getBrowserTimingHeader(options)
   const json = JSON.stringify(rumHash, null, tabs)
   // the complete header to be written to the browser
-  const out = _generateRUMHeader(options, json, jsAgentLoader)
+  const out = _generateRUMHeader(
+    { nonce: options.nonce, hasToRemoveScriptWrapper: options.hasToRemoveScriptWrapper },
+    json,
+    config.browser_monitoring.js_agent_loader
+  )
   logger.trace('generating RUM header', out)

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "newrelic",
-  "version": "9.7.5",
+  "version": "9.8.0",
   "author": "New Relic Node.js agent team <nodejs@newrelic.com>",
   "license": "Apache-2.0",
   "contributors": [