refactor: Refactored q instrumentation to subscribe to events emitted (#3853)

Author: bizob2828

lib/instrumentation/q.js

@@ -24,7 +24,6 @@ module.exports = function instrumentations() {
     memcached: { type: InstrumentationDescriptor.TYPE_DATASTORE },
     mongodb: { type: InstrumentationDescriptor.TYPE_DATASTORE },
     next: { module: './instrumentation/nextjs' },
-    q: { type: null },
     restify: { type: InstrumentationDescriptor.TYPE_WEB_FRAMEWORK },
     when: { module: './instrumentation/when' }
   }

lib/instrumentations.js

@@ -28,6 +28,7 @@ const subscribers = {
   ...require('./subscribers/openai/config'),
   ...require('./subscribers/pg/config'),
   ...require('./subscribers/pino/config'),
+  ...require('./subscribers/q/config'),
   ...require('./subscribers/redis/config'),
   ...require('./subscribers/redis-client/config'),
   ...require('./subscribers/undici/config'),

lib/subscriber-configs.js

@@ -0,0 +1,32 @@
+/*
+ * Copyright 2026 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+'use strict'
+
+module.exports = {
+  q: [
+    {
+      path: './q/next-tick',
+      instrumentations: [{
+        channelName: 'nr_nextTick',
+        module: { name: 'q', versionRange: '>=1.3.0', filePath: 'q.js' },
+        functionQuery: {
+          expressionName: 'nextTick',
+          kind: 'Sync'
+        }
+      }]
+    },
+    {
+      path: './q/run-after',
+      instrumentations: [{
+        channelName: 'nr_runAfter',
+        module: { name: 'q', versionRange: '>=1.3.0', filePath: 'q.js' },
+        functionQuery: {
+          expressionName: 'runAfter',
+          kind: 'Sync'
+        }
+      }]
+    }
+  ]
+}

lib/subscribers/q/config.js

@@ -0,0 +1,21 @@
+/*
+ * Copyright 2026 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+
+const BaseSubscriber = require('../base')
+
+module.exports = class QNextTick extends BaseSubscriber {
+  constructor({ agent, logger, channelName = 'nr_nextTick' }) {
+    super({ agent, logger, channelName, packageName: 'q' })
+    this.events = ['end']
+  }
+
+  handler(data, ctx) {
+    const { arguments: args } = data
+    data.arguments[0] = this.agent.tracer.bindFunction(args[0], ctx)
+    return ctx
+  }
+}

lib/subscribers/q/next-tick.js

@@ -0,0 +1,14 @@
+/*
+ * Copyright 2026 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+
+const QNextTick = require('./next-tick')
+
+module.exports = class QRunAfter extends QNextTick {
+  constructor({ agent, logger }) {
+    super({ agent, logger, channelName: 'nr_runAfter' })
+  }
+}

lib/subscribers/q/run-after.js

@@ -31,13 +31,14 @@ test.afterEach((ctx) => {
   removeModules(['q'])
 })
 
-test('should load tracking metrics', (t) => {
-  const { agent } = t.nr
+test('should load tracking metrics', async (t) => {
+  const { agent, q } = t.nr
   const { version } = require('q/package.json')
-  assertPackageMetrics({ agent, pkg: 'q', version })
+  await q()
+  assertPackageMetrics({ agent, pkg: 'q', version, subscriberType: true })
 })
 
-test('q.invoke', (t, end) => {
+test('q.invoke', async (t) => {
   const { agent, q } = t.nr
   const firstTest = q.defer()
   const secondTest = q.defer()
@@ -56,10 +57,10 @@ test('q.invoke', (t, end) => {
     })
   })
 
-  q.all([firstTest, secondTest]).then(() => end())
+  await q.all([firstTest.promise, secondTest.promise])
 })
 
-test('q.then', (t, end) => {
+test('q.then', async (t) => {
   const { agent, q } = t.nr
   const firstTest = q.defer()
   const secondTest = q.defer()
@@ -78,7 +79,7 @@ test('q.then', (t, end) => {
     })
   })
 
-  q.all([firstTest, secondTest]).then(() => end())
+  await q.all([firstTest.promise, secondTest.promise])
 })
 
 test('q.then rejections', async (t) => {