newrelic 8.6.0 → 8.7.0

package/NEWS.md

@@ -1,3 +1,44 @@
+### v8.7.0 (2022-01-04)
+
+* Updated `onResolved` instrumentation hook to only be called the first time we see a specific module filepath resolved.
+
+* Removed `tracer.segment` in place of direct usage of context manager.
+
+* Fixed an issue where multiple calls to `instrumentLoadedModule` resulted in re-instrumenting the same module.
+
+* Fixed issue where `instrumentLoadedModule` would return `true` even if the instrumentation handler indicated it did not apply instrumentation.
+
+* Added support metrics for tracking when instrumentation was applied per module.
+
+  * `Supportability/Features/Instrumentation/OnResolved/<module-name>`
+  * `Supportability/Features/Instrumentation/OnResolved/<module-name>/Version/<major version>`
+  * `Supportability/Features/Instrumentation/OnRequire/<module-name>`
+  * `Supportability/Features/Instrumentation/OnRequire/<module-name>/Version/<major version>`
+
+* Fixed issue where expected status code ranges would not be parsed until ignored status codes were also defined.
+
+* Added an input `changelog_file` to pass in name of changelog.  This defaults to `NEWS.md` but some repos use `CHANGELOG.md`
+
+* Abstracted `bin/prepare-release.js` to work against other repositories.  
+
+* Added reusable prepare-release workflow that can be referenced in all other newrelic Node.js repositories.
+
+* Updated pending PRs workflow to check all repos the team owns.
+
+* Changed the event type from `pull_request` to `pull_request_target` to allow for auto assign of PRs to the Node.js Engineering Board
+
+* Fixed add to board workflow to properly pass repository secrets into reusable board workflow.
+
+* Changes token used to post issues to org level project board
+
+* Runs versioned tests for external modules against tests defined in the external repository instead of tests published in npm modules.
+
+* Added a reusable workflow to automatically add issues to the Node.js Engineering Board when created.
+
+* Added CI job to update system configurations with new agent version on release.
+
+* Moved `methods.js` under bluebird versioned test folder.
+
 ### v8.6.0 (2021-11-17)
 
 * Added `onResolved` instrumentation hook to apply instrumentation prior to module load.

package/api.js

@@ -14,7 +14,6 @@ const hashes = require('./lib/util/hashes')
 const properties = require('./lib/util/properties')
 const stringify = require('json-stringify-safe')
 const shimmer = require('./lib/shimmer')
-const shims = require('./lib/shim')
 const isValidType = require('./lib/util/attribute-types')
 const TransactionShim = require('./lib/shim/transaction-shim')
 const TransactionHandle = require('./lib/transaction/handle')
@@ -1332,34 +1331,16 @@ API.prototype.instrumentLoadedModule = function instrumentLoadedModule(moduleNam
     NAMES.SUPPORTABILITY.API + '/instrumentLoadedModule'
   )
   metric.incrementCallCount()
-  try {
-    const instrumentationName = shimmer.getInstrumentationNameFromModuleName(moduleName)
-    if (!shimmer.registeredInstrumentations[instrumentationName]) {
-      logger.warn("No instrumentation registered for '%s'.", instrumentationName)
-      return false
-    }
-
-    const instrumentation = shimmer.registeredInstrumentations[instrumentationName]
-    if (!instrumentation.onRequire) {
-      logger.warn("No onRequire function registered for '%s'.", instrumentationName)
-      return false
-    }
 
+  try {
     const resolvedName = require.resolve(moduleName)
 
-    const shim = shims.createShimFromType(
-      instrumentation.type,
-      this.agent,
-      moduleName,
-      resolvedName
-    )
-
-    instrumentation.onRequire(shim, module, moduleName)
-
-    return true
+    return shimmer.instrumentPostLoad(this.agent, module, moduleName, resolvedName)
   } catch (error) {
     logger.error('instrumentLoadedModule encountered an error, module not instrumented: %s', error)
   }
+
+  return false
 }
 
 /**

package/lib/config/index.js

@@ -229,6 +229,7 @@ Config.prototype.mergeServerConfig = mergeServerConfig
  * recognized, unsupported, and unknown parameters.
  *
  * @param {object} json The config blob sent by New Relic.
+ * @param recursion
  */
 Config.prototype.onConnect = function onConnect(json, recursion) {
   json = json || Object.create(null)
@@ -865,7 +866,7 @@ Config.prototype.checkAsyncHookStatus = function checkAsyncHookStatus() {
  * I wanted to cache the DisplayHost, but if I attached the variable to the config object,
  * it sends the extra variable to New Relic, which is not desired.
  *
- * @return {string} display host name
+ * @returns {string} display host name
  */
 Config.prototype.getDisplayHost = getDisplayHost
 
@@ -903,7 +904,7 @@ function getDisplayHost() {
  * I wanted to cache the Hostname, but if I attached the variable to the config object,
  * it sends the extra variable to New Relic, which is not desired.
  *
- * @return {string} host name
+ * @returns {string} host name
  */
 Config.prototype.getHostnameSafe = getHostnameSafe
 
@@ -980,6 +981,7 @@ Config.prototype.applications = function applications() {
  *
  * @param {object} external The configuration being loaded.
  * @param {object} internal Whichever chunk of the config being overridden.
+ * @param arbitrary
  */
 Config.prototype._fromPassed = function _fromPassed(external, internal, arbitrary) {
   if (!external) {
@@ -1065,6 +1067,8 @@ Config.prototype._featureFlagsFromEnv = function _featureFlagsFromEnv() {
  *                        need to set this yourself.
  * @param object data     The current level of the configuration object. Should
  *                        never need to set this yourself.
+ * @param metadata
+ * @param data
  */
 Config.prototype._fromEnvironment = function _fromEnvironment(metadata, data) {
   if (!metadata) {
@@ -1122,7 +1126,6 @@ Config.prototype._fromEnvironment = function _fromEnvironment(metadata, data) {
  * environment variable.
  *
  * @param {*} inputConfig configuration passed to the Config constructor
- *
  * @returns {boolean}
  */
 Config.prototype._loggingManuallySet = function _loggingManuallySet(inputConfig) {
@@ -1137,7 +1140,6 @@ Config.prototype._loggingManuallySet = function _loggingManuallySet(inputConfig)
  * file or enveironment variable
  *
  * @param {*} inputConfig configuration pass to the Config constructor
- *
  * @returns {boolean}
  */
 Config.prototype._nativeMetricsManuallySet = function _nativeMetricsManuallySet(inputConfig) {
@@ -1156,7 +1158,6 @@ Config.prototype._nativeMetricsManuallySet = function _nativeMetricsManuallySet(
  * environment variable.
  *
  * @param {*} inputConfig configuration passed to the Config constructor
- *
  * @returns {boolean}
  */
 Config.prototype._DTManuallySet = function _DTManuallySet(inputConfig) {
@@ -1173,6 +1174,7 @@ Config.prototype._DTManuallySet = function _DTManuallySet(inputConfig) {
  *   - disables cross_application_tracer.enabled if set
  *   - defaults logging to disabled
  *   - verifies data specific to running DT is defined either in config file of env vars
+ *
  * @param {*} inputConfig configuration passed to the Config constructor
  */
 Config.prototype._enforceServerless = function _enforceServerless(inputConfig) {
@@ -1282,7 +1284,7 @@ Config.prototype._canonicalize = function _canonicalize() {
   }
 
   const expectedCodes = this.error_collector && this.error_collector.expected_status_codes
-  if (statusCodes) {
+  if (expectedCodes) {
     this.error_collector.expected_status_codes = _parseCodes(expectedCodes)
   }
 
@@ -1410,7 +1412,6 @@ Config.prototype._applyHighSecurity = function _applyHighSecurity() {
  *
  * @param {Agent} agent
  * @param {object} policies
- *
  * @returns {CollectorResponse} The result of the processing, with the known
  *  policies as the response payload.
  */
@@ -1540,7 +1541,7 @@ function redactValue(value) {
  * Get a JSONifiable object containing all settings we want to report to the
  * collector and store in the environment_values table.
  *
- * @return Object containing simple key-value pairs of settings
+ * @returns Object containing simple key-value pairs of settings
  */
 Config.prototype.publicSettings = function publicSettings() {
   let settings = Object.create(null)
@@ -1683,6 +1684,8 @@ function initialize(config) {
 
 /**
  * This helper function creates an empty configuration object
+ *
+ * @param config
  */
 function createNewConfigObject(config) {
   config = new Config(Object.create(null))

package/lib/metrics/names.js

@@ -252,7 +252,11 @@ const INFINITE_TRACING = {
 }
 
 const FEATURES = {
-  CERTIFICATES: SUPPORTABILITY.FEATURES + '/Certificates'
+  CERTIFICATES: SUPPORTABILITY.FEATURES + '/Certificates',
+  INSTRUMENTATION: {
+    ON_RESOLVED: SUPPORTABILITY.FEATURES + '/Instrumentation/OnResolved',
+    ON_REQUIRE: SUPPORTABILITY.FEATURES + '/Instrumentation/OnRequire'
+  }
 }
 
 module.exports = {

package/lib/shimmer.js

@@ -6,12 +6,15 @@
 'use strict'
 
 const path = require('path')
+const semver = require('semver')
 const fs = require('./util/unwrapped-core').fs
 const logger = require('./logger').child({ component: 'shimmer' })
 const INSTRUMENTATIONS = require('./instrumentations')()
 const properties = require('./util/properties')
 const shims = require('./shim')
 
+const NAMES = require('./metrics/names')
+
 const MODULE_TYPE = shims.constants.MODULE_TYPE
 
 const CORE_INSTRUMENTATION = {
@@ -286,9 +289,13 @@ const shimmer = (module.exports = {
         // This is triggered by the load call, so record the path that has been seen so
         // we can examine it after the load call has returned.
         const resolvedFilepath = resolve.apply(this, arguments)
-        filepathMap[file] = resolvedFilepath
 
-        _onResolveFileName(agent, file, resolvedFilepath)
+        // Only fire the first time we see a specific module resolved
+        if (filepathMap[file] !== resolvedFilepath) {
+          filepathMap[file] = resolvedFilepath
+
+          _onResolveFileName(agent, file, resolvedFilepath)
+        }
 
         return resolvedFilepath
       }
@@ -458,6 +465,14 @@ const shimmer = (module.exports = {
       instrumentation = moduleName
     }
     return instrumentation
+  },
+
+  instrumentPostLoad(agent, module, moduleName, resolvedName) {
+    const result = _postLoad(agent, module, moduleName, resolvedName)
+    // This is to not break the public API
+    // previously it would just call instrumentation
+    // and not check the result
+    return !!result.__NR_instrumented
   }
 })
 
@@ -502,6 +517,7 @@ function instrumentPostLoad(agent, nodule, moduleName, resolvedName) {
   const shim = shims.createShimFromType(instrumentation.type, agent, moduleName, resolvedName)
 
   applyDebugState(shim, nodule)
+  trackInstrumentationUsage(agent, shim, moduleName, NAMES.FEATURES.INSTRUMENTATION.ON_REQUIRE)
 
   try {
     if (instrumentation.onRequire(shim, nodule, moduleName) !== false) {
@@ -597,6 +613,8 @@ function _instrumentOnResolved(agent, moduleName, resolvedFilepath) {
 
   const shim = shims.createShimFromType(instrumentation.type, agent, moduleName, resolvedFilepath)
 
+  trackInstrumentationUsage(agent, shim, moduleName, NAMES.FEATURES.INSTRUMENTATION.ON_RESOLVED)
+
   try {
     instrumentation.onResolved(shim, moduleName, resolvedFilepath)
   } catch (instrumentationError) {
@@ -644,3 +662,45 @@ function hasValidRegisterOptions(opts) {
 
   return true
 }
+
+/**
+ * Adds metrics to indicate instrumentation was used for a particular module and
+ * what major version the module was at, if possible.
+ *
+ * @param {*} agent The agent instance.
+ * @param {*} shim The instance of the shim used to instrument the module.
+ * @param {string} moduleName The name of the required module.
+ * @param {string} metricPrefix Support metric prefix to prepend to the metrics. Will indicate onRequire or onResolved
+ * from NAMES.FEATURES.INSTRUMENTATION.
+ */
+function trackInstrumentationUsage(agent, shim, moduleName, metricPrefix) {
+  try {
+    const version = tryGetVersion(shim)
+    const instrumentationMetricName = `${metricPrefix}/${moduleName}`
+
+    agent.metrics.getOrCreateMetric(instrumentationMetricName).incrementCallCount()
+
+    if (version) {
+      const majorVersion = semver.major(version)
+      const versionMetricName = `${instrumentationMetricName}/Version/${majorVersion}`
+
+      agent.metrics.getOrCreateMetric(versionMetricName).incrementCallCount()
+    }
+  } catch (error) {
+    logger.debug('Unable to track instrumentation usage for: ', moduleName, error)
+  }
+}
+
+function tryGetVersion(shim) {
+  // Global module (i.e. domain) or finding root failed
+  if (shim._moduleRoot === '.') {
+    return
+  }
+
+  const packageInfo = shim.require('./package.json')
+  if (!packageInfo) {
+    return
+  }
+
+  return packageInfo.version
+}

package/lib/transaction/tracer/index.js

@@ -45,16 +45,6 @@ Tracer.prototype.wrapFunctionFirst = wrapFunctionFirst
 Tracer.prototype.wrapSyncFunction = wrapSyncFunction
 Tracer.prototype.wrapCallback = wrapCallback
 
-Object.defineProperty(Tracer.prototype, 'segment', {
-  get: function segmentGetter() {
-    return this._contextManager.getContext()
-  },
-  set: function segmentSetter(segment) {
-    this._contextManager.setContext(segment)
-    return segment
-  }
-})
-
 function getTransaction() {
   const currentSegment = this._contextManager.getContext()
   if (currentSegment && currentSegment.transaction && currentSegment.transaction.isActive()) {
@@ -69,6 +59,7 @@ function getSegment() {
   return this._contextManager.getContext()
 }
 
+// TODO: Remove/replace external uses to tracer.getSpanContext()
 function getSpanContext() {
   const currentSegment = this.getSegment()
   return currentSegment && currentSegment.getSpanContext()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "newrelic",
-  "version": "8.6.0",
+  "version": "8.7.0",
   "author": "New Relic Node.js agent team <nodejs@newrelic.com>",
   "license": "Apache-2.0",
   "contributors": [
@@ -148,10 +148,11 @@
     "update-cross-agent-tests": "./bin/update-cats.sh",
     "versioned-tests": "./bin/run-versioned-tests.sh",
     "update-changelog-version": "node ./bin/update-changelog-version",
+    "checkout-external-versioned": "node ./test/versioned-external/checkout-external-tests.js",
     "versioned": "npm run versioned:npm7",
-    "versioned:major": "npm run prepare-test && VERSIONED_MODE=--major NPM7=1 time ./bin/run-versioned-tests.sh",
-    "versioned:npm6": "npm run prepare-test && time ./bin/run-versioned-tests.sh",
-    "versioned:npm7": "npm run prepare-test && NPM7=1 time ./bin/run-versioned-tests.sh",
+    "versioned:major": "npm run checkout-external-versioned && npm run prepare-test && VERSIONED_MODE=--major NPM7=1 time ./bin/run-versioned-tests.sh",
+    "versioned:npm6": "npm run checkout-external-versioned && npm run prepare-test && time ./bin/run-versioned-tests.sh",
+    "versioned:npm7": "npm run checkout-external-versioned && npm run prepare-test && NPM7=1 time ./bin/run-versioned-tests.sh",
     "prepare": "husky install"
   },
   "bin": {