newrelic 12.1.1 → 12.2.0

package/NEWS.md

@@ -1,3 +1,24 @@
+### v12.2.0 (2024-08-19)
+
+#### Features
+
+* Added instrumentation support for Express 5 beta ([#2476](https://github.com/newrelic/node-newrelic/pull/2476)) ([06a4c2f](https://github.com/newrelic/node-newrelic/commit/06a4c2f9d62f7313fd246b4eed7f9f04f8b6345b))
+    * This will be experimental until `express@5.0.0` is generally available
+
+#### Bug fixes
+
+* Updated `koa` instrumentation to properly get the matched route name and to handle changes in `@koa/router@13.0.0` ([#2486](https://github.com/newrelic/node-newrelic/pull/2486)) ([0c2ee2f](https://github.com/newrelic/node-newrelic/commit/0c2ee2fd1698972de35a0ad2685e626a074125ed))
+
+#### Documentation
+
+* Removed reference to `@newrelic/next` in README ([#2479](https://github.com/newrelic/node-newrelic/pull/2479)) ([8740539](https://github.com/newrelic/node-newrelic/commit/8740539c4004e421e5f26d0c92216bcffb93c9cc))
+* Updated compatibility report ([#2487](https://github.com/newrelic/node-newrelic/pull/2487)) ([c0a5e64](https://github.com/newrelic/node-newrelic/commit/c0a5e646773c365897a908daf034881703dbd1df))
+
+#### Miscellaneous chores
+
+* Reverted to upstream `require-in-the-middle` ([#2473](https://github.com/newrelic/node-newrelic/pull/2473)) ([9bbc41c](https://github.com/newrelic/node-newrelic/commit/9bbc41c5be479af56d5aa0c87291d2fec607e9e4))
+* Updated aggregators unit tests to node:test ([#2481](https://github.com/newrelic/node-newrelic/pull/2481)) ([fd2d76f](https://github.com/newrelic/node-newrelic/commit/fd2d76fb2f6e8debc165700f932d57a02c3d3956))
+
 ### v12.1.1 (2024-08-15)
 
 #### Bug fixes

package/README.md

@@ -152,7 +152,6 @@ For more information on getting started, [check the Node.js docs](https://docs.n
 There are modules that can be installed and configured to accompany the Node.js agent:
 
  * [@newrelic/apollo-server-plugin](https://github.com/newrelic/newrelic-node-apollo-server-plugin): New Relic's official Apollo Server plugin for use with the Node.js agent.
- * [@newrelic/next](https://github.com/newrelic/newrelic-node-nextjs): Provides instrumentation for the [Next.js](https://github.com/vercel/next.js/) npm package.
 
 There are modules included within the Node.js agent to add more instrumentation for 3rd party modules:
 

package/THIRD_PARTY_NOTICES.md

@@ -26,6 +26,7 @@ code, the source code can be found at [https://github.com/newrelic/node-newrelic
 * [json-stringify-safe](#json-stringify-safe)
 * [module-details-from-path](#module-details-from-path)
 * [readable-stream](#readable-stream)
+* [require-in-the-middle](#require-in-the-middle)
 * [semver](#semver)
 * [winston-transport](#winston-transport)
 
@@ -541,7 +542,7 @@ SOFTWARE.
 
 ### @newrelic/security-agent
 
-This product includes source derived from [@newrelic/security-agent](https://github.com/newrelic/csec-node-agent) ([v1.4.0](https://github.com/newrelic/csec-node-agent/tree/v1.4.0)), distributed under the [UNKNOWN License](https://github.com/newrelic/csec-node-agent/blob/v1.4.0/LICENSE):
+This product includes source derived from [@newrelic/security-agent](https://github.com/newrelic/csec-node-agent) ([v1.5.0](https://github.com/newrelic/csec-node-agent/tree/v1.5.0)), distributed under the [UNKNOWN License](https://github.com/newrelic/csec-node-agent/blob/v1.5.0/LICENSE):
 
 ```
 ## New Relic Software License v1.0
@@ -676,7 +677,7 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 ### import-in-the-middle
 
-This product includes source derived from [import-in-the-middle](https://github.com/nodejs/import-in-the-middle) ([v1.9.1](https://github.com/nodejs/import-in-the-middle/tree/v1.9.1)), distributed under the [Apache-2.0 License](https://github.com/nodejs/import-in-the-middle/blob/v1.9.1/LICENSE):
+This product includes source derived from [import-in-the-middle](https://github.com/nodejs/import-in-the-middle) ([v1.11.0](https://github.com/nodejs/import-in-the-middle/tree/v1.11.0)), distributed under the [Apache-2.0 License](https://github.com/nodejs/import-in-the-middle/blob/v1.11.0/LICENSE):
 
 ```
                                  Apache License
@@ -1018,6 +1019,36 @@ IN THE SOFTWARE.
 
 ```
 
+### require-in-the-middle
+
+This product includes source derived from [require-in-the-middle](https://github.com/elastic/require-in-the-middle) ([v7.4.0](https://github.com/elastic/require-in-the-middle/tree/v7.4.0)), distributed under the [MIT License](https://github.com/elastic/require-in-the-middle/blob/v7.4.0/LICENSE):
+
+```
+The MIT License (MIT)
+
+Copyright (c) 2016-2019, Thomas Watson Steen
+Copyright (c) 2019-2023, Elasticsearch B.V.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+```
+
 ### semver
 
 This product includes source derived from [semver](https://github.com/npm/node-semver) ([v7.6.3](https://github.com/npm/node-semver/tree/v7.6.3)), distributed under the [ISC License](https://github.com/npm/node-semver/blob/v7.6.3/LICENSE):
@@ -1076,7 +1107,7 @@ SOFTWARE.
 
 ### @aws-sdk/client-s3
 
-This product includes source derived from [@aws-sdk/client-s3](https://github.com/aws/aws-sdk-js-v3) ([v3.616.0](https://github.com/aws/aws-sdk-js-v3/tree/v3.616.0)), distributed under the [Apache-2.0 License](https://github.com/aws/aws-sdk-js-v3/blob/v3.616.0/LICENSE):
+This product includes source derived from [@aws-sdk/client-s3](https://github.com/aws/aws-sdk-js-v3) ([v3.631.0](https://github.com/aws/aws-sdk-js-v3/tree/v3.631.0)), distributed under the [Apache-2.0 License](https://github.com/aws/aws-sdk-js-v3/blob/v3.631.0/LICENSE):
 
 ```
                                 Apache License
@@ -1285,7 +1316,7 @@ This product includes source derived from [@aws-sdk/client-s3](https://github.co
 
 ### @aws-sdk/s3-request-presigner
 
-This product includes source derived from [@aws-sdk/s3-request-presigner](https://github.com/aws/aws-sdk-js-v3) ([v3.616.0](https://github.com/aws/aws-sdk-js-v3/tree/v3.616.0)), distributed under the [Apache-2.0 License](https://github.com/aws/aws-sdk-js-v3/blob/v3.616.0/LICENSE):
+This product includes source derived from [@aws-sdk/s3-request-presigner](https://github.com/aws/aws-sdk-js-v3) ([v3.631.0](https://github.com/aws/aws-sdk-js-v3/tree/v3.631.0)), distributed under the [Apache-2.0 License](https://github.com/aws/aws-sdk-js-v3/blob/v3.631.0/LICENSE):
 
 ```
                                 Apache License
@@ -2179,7 +2210,7 @@ THE SOFTWARE.
 
 ### @slack/bolt
 
-This product includes source derived from [@slack/bolt](https://github.com/slackapi/bolt) ([v3.19.0](https://github.com/slackapi/bolt/tree/v3.19.0)), distributed under the [MIT License](https://github.com/slackapi/bolt/blob/v3.19.0/LICENSE):
+This product includes source derived from [@slack/bolt](https://github.com/slackapi/bolt) ([v3.21.0](https://github.com/slackapi/bolt/tree/v3.21.0)), distributed under the [MIT License](https://github.com/slackapi/bolt/blob/v3.21.0/LICENSE):
 
 ```
 The MIT License (MIT)
@@ -2683,7 +2714,7 @@ THE SOFTWARE.
 
 ### aws-sdk
 
-This product includes source derived from [aws-sdk](https://github.com/aws/aws-sdk-js) ([v2.1659.0](https://github.com/aws/aws-sdk-js/tree/v2.1659.0)), distributed under the [Apache-2.0 License](https://github.com/aws/aws-sdk-js/blob/v2.1659.0/LICENSE.txt):
+This product includes source derived from [aws-sdk](https://github.com/aws/aws-sdk-js) ([v2.1675.0](https://github.com/aws/aws-sdk-js/tree/v2.1675.0)), distributed under the [Apache-2.0 License](https://github.com/aws/aws-sdk-js/blob/v2.1675.0/LICENSE.txt):
 
 ```
 
@@ -3111,7 +3142,7 @@ THE SOFTWARE.
 
 ### eslint-plugin-jsdoc
 
-This product includes source derived from [eslint-plugin-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc) ([v48.8.0](https://github.com/gajus/eslint-plugin-jsdoc/tree/v48.8.0)), distributed under the [BSD-3-Clause License](https://github.com/gajus/eslint-plugin-jsdoc/blob/v48.8.0/LICENSE):
+This product includes source derived from [eslint-plugin-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc) ([v48.11.0](https://github.com/gajus/eslint-plugin-jsdoc/tree/v48.11.0)), distributed under the [BSD-3-Clause License](https://github.com/gajus/eslint-plugin-jsdoc/blob/v48.11.0/LICENSE):
 
 ```
 Copyright (c) 2018, Gajus Kuizinas (http://gajus.com/)
@@ -4189,7 +4220,7 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 ### @contrast/fn-inspect
 
-This product includes source derived from [@contrast/fn-inspect](https://github.com/Contrast-Security-Inc/node-fn-inspect) ([v4.2.0](https://github.com/Contrast-Security-Inc/node-fn-inspect/tree/v4.2.0)), distributed under the [MIT License](https://github.com/Contrast-Security-Inc/node-fn-inspect/blob/v4.2.0/LICENSE):
+This product includes source derived from [@contrast/fn-inspect](https://github.com/Contrast-Security-Inc/node-fn-inspect) ([v4.3.0](https://github.com/Contrast-Security-Inc/node-fn-inspect/tree/v4.3.0)), distributed under the [MIT License](https://github.com/Contrast-Security-Inc/node-fn-inspect/blob/v4.3.0/LICENSE):
 
 ```
 Copyright 2022 Contrast Security, Inc
@@ -4215,7 +4246,7 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 ### @newrelic/native-metrics
 
-This product includes source derived from [@newrelic/native-metrics](https://github.com/newrelic/node-native-metrics) ([v10.2.0](https://github.com/newrelic/node-native-metrics/tree/v10.2.0)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-native-metrics/blob/v10.2.0/LICENSE):
+This product includes source derived from [@newrelic/native-metrics](https://github.com/newrelic/node-native-metrics) ([v11.0.0](https://github.com/newrelic/node-native-metrics/tree/v11.0.0)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-native-metrics/blob/v11.0.0/LICENSE):
 
 ```
                                  Apache License

package/lib/instrumentation/express.js

@@ -6,7 +6,6 @@
 'use strict'
 
 const { MiddlewareSpec, MiddlewareMounterSpec, RenderSpec } = require('../../lib/shim/specs')
-const { MIDDLEWARE_TYPE_NAMES } = require('../../lib/shim/webframework-shim/common')
 
 /**
  * Express middleware generates traces where middleware are considered siblings
@@ -25,18 +24,8 @@ module.exports = function initialize(agent, express, moduleName, shim) {
     return err !== 'route' && err !== 'router'
   })
 
-  if (express.Router.use) {
-    wrapExpress4(shim, express)
-  } else {
-    wrapExpress3(shim, express)
-  }
-}
-
-function wrapExpress4(shim, express) {
-  // Wrap `use` and `route` which are hung off `Router` directly, not on a
-  // prototype.
   shim.wrapMiddlewareMounter(
-    express.Router,
+    express.application,
     'use',
     new MiddlewareMounterSpec({
       route: shim.FIRST,
@@ -44,8 +33,13 @@ function wrapExpress4(shim, express) {
     })
   )
 
+  wrapExpressRouter(shim, express.Router.use ? express.Router : express.Router.prototype)
+  wrapResponse(shim, express.response)
+}
+
+function wrapExpressRouter(shim, router) {
   shim.wrapMiddlewareMounter(
-    express.application,
+    router,
     'use',
     new MiddlewareMounterSpec({
       route: shim.FIRST,
@@ -53,7 +47,7 @@ function wrapExpress4(shim, express) {
     })
   )
 
-  shim.wrap(express.Router, 'route', function wrapRoute(shim, fn) {
+  shim.wrap(router, 'route', function wrapRoute(shim, fn) {
     if (!shim.isFunction(fn)) {
       return fn
     }
@@ -89,7 +83,7 @@ function wrapExpress4(shim, express) {
   })
 
   shim.wrapMiddlewareMounter(
-    express.Router,
+    router,
     'param',
     new MiddlewareMounterSpec({
       route: shim.FIRST,
@@ -105,56 +99,6 @@ function wrapExpress4(shim, express) {
       }
     })
   )
-
-  wrapResponse(shim, express.response)
-}
-
-function wrapExpress3(shim, express) {
-  // In Express 3 the app returned from `express()` is actually a `connect` app
-  // which we have no access to before creation. We can not easily wrap the app
-  // because there are a lot of methods dangling on it that act on the app itself.
-  // Really we just care about apps being used as `request` event listeners on
-  // `http.Server` instances so we'll wrap that instead.
-
-  shim.wrapMiddlewareMounter(
-    express.Router.prototype,
-    'param',
-    new MiddlewareMounterSpec({
-      route: shim.FIRST,
-      wrapper: function wrapParamware(shim, middleware, fnName, route) {
-        return shim.recordParamware(
-          middleware,
-          new MiddlewareSpec({
-            name: route,
-            req: shim.FIRST,
-            next: shim.THIRD,
-            type: MIDDLEWARE_TYPE_NAMES.PARAMWARE
-          })
-        )
-      }
-    })
-  )
-  shim.wrapMiddlewareMounter(
-    express.Router.prototype,
-    'use',
-    new MiddlewareMounterSpec({
-      route: shim.FIRST,
-      wrapper: wrapMiddleware
-    })
-  )
-  shim.wrapMiddlewareMounter(
-    express.application,
-    'use',
-    new MiddlewareMounterSpec({
-      route: shim.FIRST,
-      wrapper: wrapMiddleware
-    })
-  )
-
-  // NOTE: Do not wrap application route methods in Express 3, they all just
-  // forward their arguments to the router.
-  wrapRouteMethods(shim, express.Router.prototype, shim.FIRST)
-  wrapResponse(shim, express.response)
 }
 
 function wrapRouteMethods(shim, route, path) {

package/lib/instrumentation/koa/instrumentation.js

@@ -115,10 +115,8 @@ function wrapMatchedRoute(shim, context) {
   Object.defineProperty(context, '_matchedRoute', {
     get: () => context[symbols.koaMatchedRoute],
     set: (val) => {
-      const match = getLayerForTransactionName(context)
-
       // match should never be undefined given _matchedRoute was set
-      if (match) {
+      if (val) {
         const currentSegment = shim.getActiveSegment()
 
         // Segment/Transaction may be null, see:
@@ -131,7 +129,7 @@ function wrapMatchedRoute(shim, context) {
             transaction.nameState.popPath()
           }
 
-          transaction.nameState.appendPath(match.path)
+          transaction.nameState.appendPath(val)
           transaction.nameState.markPath()
         }
       }
@@ -169,22 +167,6 @@ function wrapResponseStatus(shim, context) {
   })
 }
 
-function getLayerForTransactionName(context) {
-  // Context.matched might be null
-  // See https://github.com/newrelic/node-newrelic-koa/pull/29
-  if (!context.matched) {
-    return null
-  }
-  for (let i = context.matched.length - 1; i >= 0; i--) {
-    const layer = context.matched[i]
-    if (layer.opts.end) {
-      return layer
-    }
-  }
-
-  return null
-}
-
 function getInheritedPropertyDescriptor(obj, property) {
   let proto = obj
   let descriptor = null

package/lib/instrumentation/langchain/nr-hooks.js

@@ -22,8 +22,16 @@ module.exports = [
     onRequire: cbManagerInstrumentation
   },
   {
+    // This block is for catching langchain internal imports
+    // of the callback manager. See:
+    // https://github.com/elastic/require-in-the-middle/pull/88#issuecomment-2124940546
     type: InstrumentationDescriptor.TYPE_GENERIC,
-    moduleName: '@langchain/core/dist/runnables/base',
+    moduleName: '@langchain/core/dist/callbacks/manager.cjs',
+    onRequire: cbManagerInstrumentation
+  },
+  {
+    type: InstrumentationDescriptor.TYPE_GENERIC,
+    moduleName: '@langchain/core/runnables',
     onRequire: runnableInstrumentation
   },
   {

package/lib/shimmer.js

@@ -11,7 +11,7 @@ const fs = require('./util/unwrapped-core').fs
 const logger = require('./logger').child({ component: 'shimmer' })
 const INSTRUMENTATIONS = require('./instrumentations')()
 const shims = require('./shim')
-const { Hook } = require('@newrelic/ritm')
+const { Hook } = require('require-in-the-middle')
 const IitmHook = require('import-in-the-middle')
 const { nrEsmProxy } = require('./symbols')
 const isAbsolutePath = require('./util/is-absolute-path')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "newrelic",
-  "version": "12.1.1",
+  "version": "12.2.0",
   "author": "New Relic Node.js agent team <nodejs@newrelic.com>",
   "license": "Apache-2.0",
   "contributors": [
@@ -197,7 +197,6 @@
   "dependencies": {
     "@grpc/grpc-js": "^1.9.4",
     "@grpc/proto-loader": "^0.7.5",
-    "@newrelic/ritm": "^7.2.0",
     "@newrelic/security-agent": "^1.3.0",
     "@tyriar/fibonacci-heap": "^2.0.7",
     "concat-stream": "^2.0.0",
@@ -207,6 +206,7 @@
     "json-stringify-safe": "^5.0.0",
     "module-details-from-path": "^1.0.3",
     "readable-stream": "^3.6.1",
+    "require-in-the-middle": "^7.4.0",
     "semver": "^7.5.2",
     "winston-transport": "^4.5.0"
   },