refactor: Migrated superagent instrumentation into agent and no longer bundle @newrelic/superagent

lib/instrumentation/superagent.js

@@ -0,0 +1,69 @@
+/*
+ * Copyright 2020 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+
+const http = require('http')
+const METHODS = http.METHODS.map((method) => method.toLowerCase())
+
+module.exports = function instrument(agent, superagent, moduleName, shim) {
+  shim.wrapExport(superagent, function wrapRequest(shim, request) {
+    if (!shim.isFunction(request)) {
+      shim.logger.debug('Not wrapping export, expected a function.')
+      return request
+    }
+
+    const wrapped = shim.wrapReturn(request, wrapSuperAgentReq)
+    Object.assign(wrapped, request)
+    shim.wrapReturn(wrapped, METHODS, wrapSuperAgentReq)
+
+    return wrapped
+  })
+
+  const proto = superagent.Request && superagent.Request.prototype
+  if (proto) {
+    shim.wrapReturn(proto, 'request', wrapHttpReq)
+    shim.wrap(proto, 'callback', wrapCallback)
+    shim.wrap(proto, 'then', wrapThen)
+  }
+}
+
+function wrapSuperAgentReq(shim, fn, name, req) {
+  // If the request already has a segment associated with it, then we'll use that
+  // one for future context. If it doesn't we'll bind it to the current segment.
+  const segment = shim.getSegment(req) || shim.getActiveSegment()
+  if (segment) {
+    shim.storeSegment(req, segment)
+    shim.bindSegment(req, 'request', segment, false)
+  }
+}
+
+function wrapHttpReq(shim, fn, name, req) {
+  const segment = shim.getSegment(req)
+  if (segment) {
+    shim.storeSegment(this, segment)
+  }
+}
+
+function wrapCallback(shim, callback) {
+  return function wrappedCallback() {
+    const segment = shim.getSegment(this)
+    if (segment && segment.transaction.isActive()) {
+      shim.bindCallbackSegment(this, '_callback', segment)
+    }
+    return callback.apply(this, arguments)
+  }
+}
+
+function wrapThen(shim, then) {
+  return function wrappedThen(resolve, reject) {
+    const segment = shim.getSegment(this) || shim.getActiveSegment()
+    if (!segment) {
+      return then.apply(this, arguments)
+    }
+
+    return shim.applySegment(then, segment, false, this, [resolve, reject])
+  }
+}

lib/instrumentations.js

@@ -10,39 +10,40 @@ const InstrumentationDescriptor = require('./instrumentation-descriptor')
 // Return a new copy of this array every time we're called
 module.exports = function instrumentations() {
   return {
-    'aws-sdk': { module: '@newrelic/aws-sdk' },
+    '@elastic/elasticsearch': { type: InstrumentationDescriptor.TYPE_DATASTORE },
+    '@grpc/grpc-js': { module: './instrumentation/grpc-js' },
+    '@hapi/hapi': { type: InstrumentationDescriptor.TYPE_WEB_FRAMEWORK },
+    '@hapi/vision': { type: InstrumentationDescriptor.TYPE_WEB_FRAMEWORK },
+    '@nestjs/core': { type: InstrumentationDescriptor.TYPE_WEB_FRAMEWORK },
+    '@node-redis/client': { type: InstrumentationDescriptor.TYPE_DATASTORE },
+    '@prisma/client': { type: InstrumentationDescriptor.TYPE_DATASTORE },
+    '@redis/client': { type: InstrumentationDescriptor.TYPE_DATASTORE },
     'amqplib': { module: './instrumentation/amqplib' },
-    'cassandra-driver': { type: InstrumentationDescriptor.TYPE_DATASTORE },
-    'connect': { type: InstrumentationDescriptor.TYPE_WEB_FRAMEWORK },
+    'aws-sdk': { module: '@newrelic/aws-sdk' },
     'bluebird': { type: InstrumentationDescriptor.TYPE_PROMISE },
     'bunyan': { type: InstrumentationDescriptor.TYPE_GENERIC },
+    'cassandra-driver': { type: InstrumentationDescriptor.TYPE_DATASTORE },
+    'connect': { type: InstrumentationDescriptor.TYPE_WEB_FRAMEWORK },
     'director': { type: InstrumentationDescriptor.TYPE_WEB_FRAMEWORK },
-    '@elastic/elasticsearch': { type: InstrumentationDescriptor.TYPE_DATASTORE },
     'express': { type: InstrumentationDescriptor.TYPE_WEB_FRAMEWORK },
     'fastify': { type: InstrumentationDescriptor.TYPE_WEB_FRAMEWORK },
     'generic-pool': { type: InstrumentationDescriptor.TYPE_GENERIC },
-    '@grpc/grpc-js': { module: './instrumentation/grpc-js' },
-    '@hapi/hapi': { type: InstrumentationDescriptor.TYPE_WEB_FRAMEWORK },
     'ioredis': { type: InstrumentationDescriptor.TYPE_DATASTORE },
     'koa': { module: '@newrelic/koa' },
     'langchain': { module: './instrumentation/langchain' },
     'memcached': { type: InstrumentationDescriptor.TYPE_DATASTORE },
     'mongodb': { type: InstrumentationDescriptor.TYPE_DATASTORE },
     'mysql': { module: './instrumentation/mysql' },
     'openai': { type: InstrumentationDescriptor.TYPE_GENERIC },
-    '@nestjs/core': { type: InstrumentationDescriptor.TYPE_WEB_FRAMEWORK },
-    '@prisma/client': { type: InstrumentationDescriptor.TYPE_DATASTORE },
-    'pino': { module: './instrumentation/pino' },
     'pg': { type: InstrumentationDescriptor.TYPE_DATASTORE },
+    'pino': { module: './instrumentation/pino' },
     'q': { type: null },
     'redis': { type: InstrumentationDescriptor.TYPE_DATASTORE },
-    '@node-redis/client': { type: InstrumentationDescriptor.TYPE_DATASTORE },
-    '@redis/client': { type: InstrumentationDescriptor.TYPE_DATASTORE },
     'restify': { type: InstrumentationDescriptor.TYPE_WEB_FRAMEWORK },
-    'superagent': { module: '@newrelic/superagent' },
-    '@hapi/vision': { type: InstrumentationDescriptor.TYPE_WEB_FRAMEWORK },
+    'superagent': { type: InstrumentationDescriptor.TYPE_GENERIC },
     'when': { module: './instrumentation/when' },
     'winston': { type: InstrumentationDescriptor.TYPE_GENERIC },
+
     /**
      * The modules below are listed here purely to take
      * advantage of the Supportability/Features/onRequire/<module>
@@ -52,11 +53,11 @@ module.exports = function instrumentations() {
      *  Libraries that have OpenTelemetry instrumentation we want to register
      *  or have already registered.
      */
-    'loglevel': { type: InstrumentationDescriptor.TYPE_TRACKING },
-    'npmlog': { type: InstrumentationDescriptor.TYPE_TRACKING },
+    '@azure/openai': { type: InstrumentationDescriptor.TYPE_TRACKING },
+    '@langchain/community/llms/bedrock': { type: InstrumentationDescriptor.TYPE_TRACKING },
     'fancy-log': { type: InstrumentationDescriptor.TYPE_TRACKING },
     'knex': { type: InstrumentationDescriptor.TYPE_TRACKING },
-    '@azure/openai': { type: InstrumentationDescriptor.TYPE_TRACKING },
-    '@langchain/community/llms/bedrock': { type: InstrumentationDescriptor.TYPE_TRACKING }
+    'loglevel': { type: InstrumentationDescriptor.TYPE_TRACKING },
+    'npmlog': { type: InstrumentationDescriptor.TYPE_TRACKING }
   }
 }

package.json

@@ -197,7 +197,6 @@
     "@newrelic/koa": "^9.1.0",
     "@newrelic/ritm": "^7.2.0",
     "@newrelic/security-agent": "^1.1.1",
-    "@newrelic/superagent": "^7.0.1",
     "@tyriar/fibonacci-heap": "^2.0.7",
     "concat-stream": "^2.0.0",
     "https-proxy-agent": "^7.0.1",
@@ -248,6 +247,7 @@
     "rimraf": "^2.6.3",
     "should": "*",
     "sinon": "^4.5.0",
+    "superagent": "^8.1.2",
     "tap": "^16.3.4",
     "temp": "^0.8.1",
     "when": "*"

test/unit/instrumentation/superagent/newrelic.js

@@ -0,0 +1,25 @@
+/*
+ * Copyright 2020 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+
+exports.config = {
+  app_name: ['My Application'],
+  license_key: 'license key here',
+  logging: {
+    level: 'trace',
+    filepath: '../../newrelic_agent.log'
+  },
+  utilization: {
+    detect_aws: false,
+    detect_pcf: false,
+    detect_azure: false,
+    detect_gcp: false,
+    detect_docker: false
+  },
+  transaction_tracer: {
+    enabled: true
+  }
+}

test/unit/instrumentation/superagent/superagent.test.js

@@ -0,0 +1,45 @@
+/*
+ * Copyright 2020 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+'use strict'
+
+const tap = require('tap')
+const helper = require('../../../lib/agent_helper')
+const sinon = require('sinon')
+
+tap.beforeEach((t) => {
+  t.context.agent = helper.loadMockedAgent()
+})
+
+tap.afterEach((t) => {
+  helper.unloadAgent(t.context.agent)
+})
+
+tap.test('SuperAgent instrumentation', (t) => {
+  helper.unloadAgent(t.context.agent)
+  t.context.agent = helper.loadMockedAgent({
+    moduleName: 'superagent',
+    type: 'generic',
+    onRequire: '../../lib/instrumentation'
+  })
+  const superagent = require('superagent')
+
+  t.ok(superagent.Request, 'should not remove Request class')
+  t.type(superagent.Request.prototype.then, 'function')
+  t.type(superagent.Request.prototype.end, 'function')
+
+  t.end()
+})
+
+tap.test('should not wrap superagent if it is not a function', (t) => {
+  const api = helper.getAgentApi()
+  api.shim.logger.debug = sinon.stub()
+  const instrumentation = require('../../../../lib/instrumentation/superagent')
+  const superagentMock = { foo: 'bar' }
+  instrumentation(t.context.agent, superagentMock, 'superagent', api.shim)
+  t.equal(api.shim.logger.debug.callCount, 1, 'should call debug logger')
+  t.equal(api.shim.logger.debug.args[0][0], 'Not wrapping export, expected a function.')
+  t.end()
+})

test/versioned-external/external-repos.js

@@ -27,11 +27,6 @@ const repos = [
     repository: 'https://github.com/newrelic/newrelic-node-nextjs.git',
     branch: 'main'
   },
-  {
-    name: 'superagent',
-    repository: 'https://github.com/newrelic/node-newrelic-superagent.git',
-    branch: 'main'
-  },
   {
     name: 'apollo-server',
     repository: 'https://github.com/newrelic/newrelic-node-apollo-server-plugin.git',