fixes

Author: jsumners-nr

lib/subscribers/resolve-package-version.js

@@ -10,6 +10,9 @@ const defaultLogger = require('#agentlib/logger.js').child({
   component: 'resolve-module-version'
 })
 
+const dcFuncFrame = /^\s*at Channel\.publish/
+const modPathReg = /at .+ \((.+):\d+:\d+\)/
+
 module.exports = resolveModuleVersion
 
 /**
@@ -18,21 +21,36 @@ module.exports = resolveModuleVersion
  * been bundled with Node.js (e.g. `undici`), a package manifest will not be
  * available. In this case, the string "unknown" will be returned.
  *
+ * This version resolver assumes that it will be invoked through our
+ * diagnostics channel subscriber instrumentations. That is, it expects the
+ * call tree to be similar to:
+ *
+ * 1. some-module.function()
+ * 2. diagnostics_channel.publish()
+ * 3. subscriber.handler()
+ *
  * @param {string} moduleSpecifier What would be passed to `resolve()`.
  * @param {object} [deps] Optional dependencies.
  * @param {object} [deps.logger] Agent logger instance.
- * @param {Function} [deps.req] Node.js require function.
  *
  * @returns {string} The version string from the package manifest or "unknown".
  */
-function resolveModuleVersion(moduleSpecifier, {
-  logger = defaultLogger,
-  req = require
-} = {}) {
+function resolveModuleVersion(moduleSpecifier, { logger = defaultLogger } = {}) {
   let pkgPath
-  try {
-    pkgPath = req.resolve(moduleSpecifier)
-  } catch {
+  // We'd prefer to use `require.resolve(moduleSpecifier)` here, but it gets
+  // a bit confused when there are non-standard module directories in play.
+  // Once we are able to refactor our "on require" metric recording to
+  // utilize `module.registerHooks`, we should be able to eliminate this
+  // slow algorithm.
+  const err = Error()
+  const stack = err.stack.split('\n')
+  do {
+    stack.shift()
+  } while (dcFuncFrame.test(stack[0]) === false && stack.length > 0)
+  const matches = modPathReg.exec(stack[1])
+  pkgPath = matches?.[1]
+
+  if (!pkgPath) {
     logger.warn(
       { moduleSpecifier },
       'Could not resolve module path. Possibly a built-in or Node.js bundled module.'
@@ -47,7 +65,7 @@ function resolveModuleVersion(moduleSpecifier, {
   do {
     try {
       pkgPath = path.join(base, 'package.json')
-      pkg = req(pkgPath)
+      pkg = require(pkgPath)
     } catch {
       base = path.resolve(path.join(base, '..'))
       if (base === cwd) {

test/lib/custom-assertions/assert-pkg-tracking-metrics.js

@@ -50,5 +50,21 @@ module.exports = function assertPackageMetrics(
     metrics.push([{ name: `${prefix}${suffix}` }])
   }
 
-  assertMetrics(agent.metrics, metrics, false, false, { assert })
+  try {
+    assertMetrics(agent.metrics, metrics, false, false, { assert })
+  } catch {
+    const expected = metrics.flat().map((m) => m.name)
+    const foundMetrics = Object.keys(agent.metrics._metrics.unscoped).filter(
+      (k) => k.toLowerCase().startsWith('supportability')
+    )
+    const msg = '\nExpected supportability metrics:\n' +
+      JSON.stringify(expected, null, 2) +
+      '\nBut only present supportability metrics:\n' +
+      JSON.stringify(foundMetrics, null, 2)
+    if (typeof assert.fail === 'function') {
+      assert.fail(msg)
+    } else {
+      throw Error(msg)
+    }
+  }
 }

test/unit/lib/subscribers/dc-base.test.js

@@ -12,7 +12,7 @@ const loggerMock = require('../../mocks/logger')
 const helper = require('#testlib/agent_helper.js')
 const Subscriber = require('#agentlib/subscribers/dc-base.js')
 
-const PROCESS_MAJOR = process.version.slice(1).split('.', 1)
+const PROCESS_MAJOR = require('../../../../package.json').version.split('.')[0]
 
 test.beforeEach((ctx) => {
   const agent = helper.loadMockedAgent()

test/unit/lib/subscribers/fixtures/baz/index.js

@@ -0,0 +1,15 @@
+/*
+ * Copyright 2026 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+
+const dc = require('node:diagnostics_channel')
+const chan = dc.channel('baz.test')
+
+module.exports = class Foo {
+  baz() {
+    chan.publish({ hello: 'world' })
+  }
+}

test/unit/lib/subscribers/fixtures/foo/index.js

@@ -0,0 +1,15 @@
+/*
+ * Copyright 2026 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+
+const dc = require('node:diagnostics_channel')
+const chan = dc.channel('foo.test')
+
+module.exports = class Foo {
+  foo() {
+    chan.publish({ hello: 'world' })
+  }
+}

test/unit/lib/subscribers/fixtures/foo/lib/bar.js

@@ -0,0 +1,15 @@
+/*
+ * Copyright 2026 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+
+const dc = require('node:diagnostics_channel')
+const chan = dc.channel('bar.test')
+
+module.exports = class Bar {
+  bar() {
+    chan.publish({ hello: 'world' })
+  }
+}

test/unit/lib/subscribers/fixtures/foo/package.json

@@ -0,0 +1,3 @@
+{
+  "version": "1.0.0"
+}

test/unit/lib/subscribers/resolve-package-version.test.js

@@ -6,8 +6,14 @@
 'use strict'
 
 const test = require('node:test')
+const dc = require('node:diagnostics_channel')
 const resolvePackageVersion = require('#agentlib/subscribers/resolve-package-version.js')
 
+const nrPkg = require('../../../../package.json')
+const Foo = require('./fixtures/foo/index.js')
+const Bar = require('./fixtures/foo/lib/bar.js')
+const Baz = require('./fixtures/baz/index.js')
+
 test.beforeEach((ctx) => {
   ctx.nr = {
     logs: {
@@ -36,96 +42,72 @@ test('logs if module cannot be found', (t) => {
   ])
 })
 
-test('returns unknown if manifest does not have version field', (t) => {
-  t.plan(4)
-  const req = (specifier) => {
-    t.assert.equal(specifier, 'test/package.json')
-    return {}
-  }
-  req.resolve = (specifier) => {
-    t.assert.equal(specifier, 'foo')
-    return 'test/foo'
-  }
+test('iterates up the tree to the package.json', (t) => {
+  t.plan(2)
 
-  const result = resolvePackageVersion('foo', { ...t.nr, req })
-  t.assert.equal(result, 'unknown')
-  t.assert.deepStrictEqual(t.nr.logs.trace, [
-    [
-      { moduleSpecifier: 'foo', version: 'unknown' },
-      'Resolved package version.'
-    ]
-  ])
-})
+  t.after(() => {
+    dc.unsubscribe('bar.test', handler)
+  })
 
-test('iterates up the tree to the package.json', (t) => {
-  t.plan(3)
-  const req = (specifier) => {
-    if (specifier === 'test/lib/package.json') {
-      throw Error('not found')
-    }
-    if (specifier.endsWith('test/package.json')) {
-      return { version: '1.0.0' }
-    }
-  }
-  req.resolve = (specifier) => {
-    t.assert.equal(specifier, 'foo')
-    return 'test/lib/foo'
-  }
+  dc.subscribe('bar.test', handler)
+  const bar = new Bar()
+  bar.bar()
 
-  const result = resolvePackageVersion('foo', { ...t.nr, req })
-  t.assert.equal(result, '1.0.0')
-  t.assert.deepStrictEqual(t.nr.logs.trace, [
-    [
-      { moduleSpecifier: 'foo', version: '1.0.0' },
-      'Resolved package version.'
-    ]
-  ])
+  function handler() {
+    const result = resolvePackageVersion('foo', t.nr)
+    t.assert.equal(result, '1.0.0')
+    t.assert.deepStrictEqual(t.nr.logs.trace, [
+      [
+        { moduleSpecifier: 'foo', version: '1.0.0' },
+        'Resolved package version.'
+      ]
+    ])
+  }
 })
 
 test('stops looking after reaching app root', (t) => {
-  t.plan(3)
-  const req = (specifier) => {
-    if (specifier === 'test/lib/package.json') {
-      throw Error('not found')
-    }
-    if (specifier.endsWith('test/package.json')) {
-      throw Error('try again')
-    }
-    throw Error('app root, no manifest')
-  }
-  req.resolve = (specifier) => {
-    t.assert.equal(specifier, 'foo')
-    return 'test/lib/foo'
-  }
+  t.plan(2)
 
-  const result = resolvePackageVersion('foo', { ...t.nr, req })
-  t.assert.equal(result, 'unknown')
-  t.assert.deepStrictEqual(t.nr.logs.trace, [
-    [
-      { moduleSpecifier: 'foo', version: 'unknown' },
-      'Resolved package version.'
-    ]
-  ])
+  t.after(() => {
+    dc.unsubscribe('baz.test', handler)
+  })
+
+  dc.subscribe('baz.test', handler)
+  const baz = new Baz()
+  baz.baz()
+
+  function handler() {
+    const result = resolvePackageVersion('baz', t.nr)
+    t.assert.equal(result, nrPkg.version)
+    t.assert.deepStrictEqual(t.nr.logs.trace, [
+      [
+        { moduleSpecifier: 'baz', version: nrPkg.version },
+        'Resolved package version.'
+      ]
+    ])
+  }
 })
 
 test('returns version', (t) => {
-  t.plan(5)
-  const req = (specifier) => {
-    t.assert.equal(specifier, 'test/package.json')
-    return { version: '1.0.0' }
-  }
-  req.resolve = (specifier) => {
-    t.assert.equal(specifier, 'foo')
-    return 'test/foo'
-  }
+  t.plan(2)
 
-  const result = resolvePackageVersion('foo', { ...t.nr, req })
-  t.assert.equal(result, '1.0.0')
-  t.assert.deepStrictEqual(t.nr.logs.trace, [
-    [
-      { moduleSpecifier: 'foo', version: '1.0.0' },
-      'Resolved package version.'
-    ]
-  ])
-  t.assert.equal(t.nr.logs.warn.length, 0)
+  t.after(() => {
+    dc.unsubscribe('foo.test', handler)
+  })
+
+  dc.subscribe('foo.test', handler)
+  const foo = new Foo()
+  foo.foo()
+
+  // eslint-disable-next-line sonarjs/no-identical-functions
+  function handler() {
+    const result = resolvePackageVersion('foo', t.nr)
+    t.assert.equal(result, '1.0.0')
+    t.assert.deepStrictEqual(t.nr.logs.trace, [
+      [
+        { moduleSpecifier: 'foo', version: '1.0.0' },
+        'Resolved package version.'
+      ]
+    ])
+  }
 })

test/unit/lib/subscribers/undici.test.js

@@ -72,7 +72,7 @@ test('undici instrumentation', async function (t) {
       segment.start()
       agent.tracer.setSegment({ segment, transaction: tx })
       channels.create.publish({ request: { origin: HOST, path: '/foo' } })
-      assert.ok(loggerMock.trace.callCount, 1)
+      assert.equal(loggerMock.trace.callCount, 1)
       assert.deepEqual(loggerMock.trace.args[0], [
         'Not capturing data for outbound request (%s) because parent segment opaque (%s)',
         '/foo',

test/versioned/elastic/elasticsearch.test.js

@@ -406,8 +406,17 @@ test('Elasticsearch instrumentation', async (t) => {
       }
       expected['Datastore/instance/ElasticSearch/' + HOST_ID] = 5
       checkMetrics(unscoped, expected)
-      const pkgName = '@elastic/elasticsearch'
-      assertPackageMetrics({ agent, pkg: pkgName, version: pkgVersion, subscriberType: true })
+
+      let version = pkgVersion
+      let pkgName
+      const major = Number(pkgVersion.split('.', 1))
+      if (major >= 8) {
+        pkgName = '@elastic/transport'
+        version = helper.readPackageVersion(__dirname, pkgName)
+      } else {
+        pkgName = '@elastic/elasticsearch'
+      }
+      assertPackageMetrics({ agent, pkg: pkgName, version, subscriberType: true })
     })
   })