newrelic 11.10.0 → 11.10.1

package/NEWS.md

@@ -1,3 +1,10 @@
+### v11.10.1 (2024-01-25)
+
+#### Bug fixes
+
+* Updated instrumentation registration to allow for instrumenting of a local file that does not exist within node_modules. 
+  * To properly instrument a local file, you must pass in `absolutePath` with the absolute path to the file that is being instrumented along with the `moduleName` which in this case is just the file name without the extension. ([#1974](https://github.com/newrelic/node-newrelic/pull/1974)) ([f545b4e](https://github.com/newrelic/node-newrelic/commit/f545b4ebc3394f0a7179a51e156c6df28896edf0))
+
 ### v11.10.0 (2024-01-22)
 
 #### Features

package/api.js

@@ -1312,7 +1312,7 @@ API.prototype.recordCustomEvent = function recordCustomEvent(eventType, attribut
  *
  * @param {string|object} moduleName The module name given to require to load the module, or the instrumentation specification
  * @param {string} moduleName.moduleName The module name given to require to load the module
- * @param {Function}  moduleName.onResolved The function to call prior to module load after the filepath has been resolved
+ * @param {string} [moduleName.absolutePath] Must provide absolute path to module if it does not exist within node_modules. This is used to instrument a file within the same application.
  * @param {Function}  moduleName.onRequire The function to call when the module has been loaded
  * @param {Function} [moduleName.onError] If provided, should `onRequire` throw an error, the error will be passed to
  * @param {Function} onRequire The function to call when the module has been loaded
@@ -1343,7 +1343,7 @@ API.prototype.instrument = function instrument(moduleName, onRequire, onError) {
  *
  * @param {string|object} moduleName The module name given to require to load the module, or the instrumentation specification
  * @param {string} moduleName.moduleName The module name given to require to load the module
- * @param {Function}  moduleName.onResolved The function to call prior to module load after the filepath has been resolved
+ * @param {string} [moduleName.absolutePath] Must provide absolute path to module if it does not exist within node_modules. This is used to instrument a file within the same application.
  * @param {Function}  moduleName.onRequire The function to call when the module has been loaded
  * @param {Function} [moduleName.onError] If provided, should `onRequire` throw an error, the error will be passed to
  * @param {Function} onRequire The function to call when the module has been loaded
@@ -1375,7 +1375,7 @@ API.prototype.instrumentConglomerate = function instrumentConglomerate(
  *
  * @param {string|object} moduleName The module name given to require to load the module, or the instrumentation specification
  * @param {string} moduleName.moduleName The module name given to require to load the module
- * @param {Function}  moduleName.onResolved The function to call prior to module load after the filepath has been resolved
+ * @param {string} [moduleName.absolutePath] Must provide absolute path to module if it does not exist within node_modules. This is used to instrument a file within the same application.
  * @param {Function}  moduleName.onRequire The function to call when the module has been loaded
  * @param {Function} [moduleName.onError] If provided, should `onRequire` throw an error, the error will be passed to
  * @param {Function} onRequire The function to call when the module has been loaded
@@ -1408,7 +1408,7 @@ API.prototype.instrumentDatastore = function instrumentDatastore(moduleName, onR
  *
  * @param {string|object} moduleName The module name given to require to load the module, or the instrumentation specification
  * @param {string} moduleName.moduleName The module name given to require to load the module
- * @param {Function}  moduleName.onResolved The function to call prior to module load after the filepath has been resolved
+ * @param {string} [moduleName.absolutePath] Must provide absolute path to module if it does not exist within node_modules. This is used to instrument a file within the same application.
  * @param {Function}  moduleName.onRequire The function to call when the module has been loaded
  * @param {Function} [moduleName.onError] If provided, should `onRequire` throw an error, the error will be passed to
  * @param {Function} onRequire The function to call when the module has been loaded
@@ -1445,7 +1445,7 @@ API.prototype.instrumentWebframework = function instrumentWebframework(
  *
  * @param {string|object} moduleName The module name given to require to load the module, or the instrumentation specification
  * @param {string} moduleName.moduleName The module name given to require to load the module
- * @param {Function}  moduleName.onResolved The function to call prior to module load after the filepath has been resolved
+ * @param {string} [moduleName.absolutePath] Must provide absolute path to module if it does not exist within node_modules. This is used to instrument a file within the same application.
  * @param {Function}  moduleName.onRequire The function to call when the module has been loaded
  * @param {Function} [moduleName.onError] If provided, should `onRequire` throw an error, the error will be passed to
  * @param {Function} onRequire The function to call when the module has been loaded

package/lib/shimmer.js

@@ -398,11 +398,17 @@ const shimmer = (module.exports = {
 
     if (!registeredInstrumentation) {
       shimmer.registeredInstrumentations[opts.moduleName] = []
+      // In cases where a customer is trying to instrument a file
+      // that is not within node_modules, they must provide the absolutePath
+      // so require-in-the-middle can call our callback. the moduleName
+      // still needs to be the resolved name so we can look up our instrumentation correctly
+      const pkgHook = opts.absolutePath || opts.moduleName
+
       // not using a set because this is shared by reference
       // to allow custom instrumentation to be loaded after the
       // agent is bootstrapped
-      if (!pkgsToHook.includes(opts.moduleName)) {
-        pkgsToHook.push(opts.moduleName)
+      if (!pkgsToHook.includes(pkgHook)) {
+        pkgsToHook.push(pkgHook)
       }
     }
 

package/package.json

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