dd-trace 4.0.0-pre-c2a4fd2 → 4.0.0-pre-d46f64a

package/LICENSE-3rdparty.csv

@@ -57,6 +57,7 @@ dev,multer,MIT,Copyright 2014 Hage Yaapa
 dev,msgpack-lite,MIT,Copyright 2015 Yusuke Kawasaki
 dev,nock,MIT,Copyright 2017 Pedro Teixeira and other contributors
 dev,nyc,ISC,Copyright 2015 Contributors
+dev,pprof-format,MIT,Copyright 2022 Stephen Belanger
 dev,proxyquire,MIT,Copyright 2013 Thorsten Lorenz
 dev,rimraf,ISC,Copyright Isaac Z. Schlueter and Contributors
 dev,sinon,BSD-3-Clause,Copyright 2010-2017 Christian Johansen

package/README.md

@@ -93,6 +93,10 @@ $ docker-compose up -d -V --remove-orphans --force-recreate
 $ yarn services
 ```
 
+> **Note**
+> The `couchbase`, `grpc` and `oracledb` instrumentations rely on native modules
+> that do not compile on ARM64 devices (for example M1/M2 Mac) - their tests
+> cannot be run locally on these devices.
 
 ### Unit Tests
 

package/ci/init.js

@@ -3,13 +3,15 @@ const tracer = require('../packages/dd-trace')
 const { ORIGIN_KEY } = require('../packages/dd-trace/src/constants')
 const { isTrue } = require('../packages/dd-trace/src/util')
 
+const isJestWorker = !!process.env.JEST_WORKER_ID
+
 const options = {
   startupLogs: false,
   tags: {
     [ORIGIN_KEY]: 'ciapp-test'
   },
   isCiVisibility: true,
-  flushInterval: 5000
+  flushInterval: isJestWorker ? 0 : 5000
 }
 
 let shouldInit = true
@@ -33,6 +35,12 @@ so dd-trace will not be initialized.`)
   }
 }
 
+if (isJestWorker) {
+  options.experimental = {
+    exporter: 'jest_worker'
+  }
+}
+
 if (shouldInit) {
   tracer.init(options)
   tracer.use('fs', false)

package/ext/exporters.d.ts

@@ -2,7 +2,8 @@ declare const exporters: {
   LOG: 'log',
   AGENT: 'agent',
   DATADOG: 'datadog',
-  AGENT_PROXY: 'agent_proxy'
+  AGENT_PROXY: 'agent_proxy',
+  JEST_WORKER: 'jest_worker'
 }
 
 export = exporters

package/ext/exporters.js

@@ -3,5 +3,6 @@ module.exports = {
   LOG: 'log',
   AGENT: 'agent',
   DATADOG: 'datadog',
-  AGENT_PROXY: 'agent_proxy'
+  AGENT_PROXY: 'agent_proxy',
+  JEST_WORKER: 'jest_worker'
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dd-trace",
-  "version": "4.0.0-pre-c2a4fd2",
+  "version": "4.0.0-pre-d46f64a",
   "description": "Datadog APM tracing client for JavaScript",
   "main": "index.js",
   "typings": "index.d.ts",
@@ -61,10 +61,10 @@
   },
   "dependencies": {
     "@datadog/native-appsec": "2.0.0",
-    "@datadog/native-iast-rewriter": "1.1.2",
-    "@datadog/native-iast-taint-tracking": "1.1.0",
+    "@datadog/native-iast-rewriter": "2.0.1",
+    "@datadog/native-iast-taint-tracking": "1.1.1",
     "@datadog/native-metrics": "^1.5.0",
-    "@datadog/pprof": "^1.1.1",
+    "@datadog/pprof": "^2.0.0",
     "@datadog/sketches-js": "^2.1.0",
     "crypto-randomuuid": "^1.0.0",
     "diagnostics_channel": "^1.1.0",
@@ -120,6 +120,7 @@
     "multer": "^1.4.5-lts.1",
     "nock": "^11.3.3",
     "nyc": "^15.1.0",
+    "pprof-format": "^2.0.7",
     "proxyquire": "^1.8.0",
     "rimraf": "^3.0.0",
     "sinon": "^11.1.2",

package/packages/datadog-instrumentations/src/google-cloud-pubsub.js

@@ -15,46 +15,106 @@ const receiveStartCh = channel(`apm:google-cloud-pubsub:receive:start`)
 const receiveFinishCh = channel('apm:google-cloud-pubsub:receive:finish')
 const receiveErrorCh = channel('apm:google-cloud-pubsub:receive:error')
 
-addHook({ name: '@google-cloud/pubsub', versions: ['>=1.2'] }, (obj) => {
-  const PubSub = obj.PubSub
-  const Subscription = obj.Subscription
-
-  shimmer.wrap(PubSub.prototype, 'request', request => function (cfg = { reqOpts: {} }, cb) {
-    if (!requestStartCh.hasSubscribers) {
-      return request.apply(this, arguments)
-    }
+const publisherMethods = [
+  'createTopic',
+  'updateTopic',
+  'publish',
+  'getTopic',
+  'listTopics',
+  'listTopicSubscriptions',
+  'listTopicSnapshots',
+  'deleteTopic',
+  'detachSubscription'
+]
+
+const schemaServiceMethods = [
+  'createSchema',
+  'getSchema',
+  'listSchemas',
+  'listSchemaRevisions',
+  'commitSchema',
+  'rollbackSchema',
+  'deleteSchemaRevision',
+  'deleteSchema',
+  'validateSchema',
+  'validateMessage'
+]
+
+const subscriberMethods = [
+  'createSubscription',
+  'getSubscription',
+  'updateSubscription',
+  'listSubscriptions',
+  'deleteSubscription',
+  'modifyAckDeadline',
+  'acknowledge',
+  'pull',
+  'streamingPull',
+  'modifyPushConfig',
+  'getSnapshot',
+  'listSnapshots',
+  'createSnapshot',
+  'updateSnapshot',
+  'deleteSnapshot',
+  'seek'
+]
+
+function wrapMethod (method) {
+  const api = method.name
+
+  return function (request) {
+    if (!requestStartCh.hasSubscribers) return request.apply(this, arguments)
 
     const innerAsyncResource = new AsyncResource('bound-anonymous-fn')
-    const outerAsyncResource = new AsyncResource('bound-anonymous-fn')
 
     return innerAsyncResource.runInAsyncScope(() => {
-      let messages = []
-      if (cfg.reqOpts && cfg.method === 'publish') {
-        messages = cfg.reqOpts.messages
-      }
+      const projectId = this.auth._cachedProjectId
+      const cb = arguments[arguments.length - 1]
+
+      requestStartCh.publish({ request, api, projectId })
 
-      requestStartCh.publish({ cfg, projectId: this.projectId, messages })
-      cb = outerAsyncResource.bind(cb)
+      if (typeof cb === 'function') {
+        const outerAsyncResource = new AsyncResource('bound-anonymous-fn')
 
-      const fn = () => {
-        arguments[1] = innerAsyncResource.bind(function (error) {
+        arguments[arguments.length - 1] = innerAsyncResource.bind(function (error) {
           if (error) {
             requestErrorCh.publish(error)
           }
-          requestFinishCh.publish(undefined)
-          return cb.apply(this, arguments)
+
+          requestFinishCh.publish()
+
+          return outerAsyncResource.runInAsyncScope(() => cb.apply(this, arguments))
         })
-        return request.apply(this, arguments)
-      }
 
-      try {
-        return fn.apply(this, arguments)
-      } catch (e) {
-        requestErrorCh.publish(e)
-        throw e
+        return method.apply(this, arguments)
+      } else {
+        return method.apply(this, arguments)
+          .then(
+            response => {
+              requestFinishCh.publish()
+              return response
+            },
+            error => {
+              requestErrorCh.publish(error)
+              requestFinishCh.publish()
+              throw error
+            }
+          )
       }
     })
-  })
+  }
+}
+
+function massWrap (obj, methods, wrapper) {
+  for (const method of methods) {
+    if (typeof obj[method] === 'function') {
+      shimmer.wrap(obj, method, wrapper)
+    }
+  }
+}
+
+addHook({ name: '@google-cloud/pubsub', versions: ['>=1.2'] }, (obj) => {
+  const Subscription = obj.Subscription
 
   shimmer.wrap(Subscription.prototype, 'emit', emit => function (eventName, message) {
     if (eventName !== 'message' || !message) return emit.apply(this, arguments)
@@ -98,3 +158,16 @@ addHook({ name: '@google-cloud/pubsub', versions: ['>=1.2'], file: 'build/src/le
 
   return obj
 })
+
+addHook({ name: '@google-cloud/pubsub', versions: ['>=1.2'] }, (obj) => {
+  const { PublisherClient, SchemaServiceClient, SubscriberClient } = obj.v1
+
+  massWrap(PublisherClient.prototype, publisherMethods, wrapMethod)
+  massWrap(SubscriberClient.prototype, subscriberMethods, wrapMethod)
+
+  if (SchemaServiceClient) {
+    massWrap(SchemaServiceClient.prototype, schemaServiceMethods, wrapMethod)
+  }
+
+  return obj
+})

package/packages/datadog-instrumentations/src/jest.js

@@ -2,7 +2,11 @@
 const { addHook, channel, AsyncResource } = require('./helpers/instrument')
 const shimmer = require('../../datadog-shimmer')
 const log = require('../../dd-trace/src/log')
-const { getCoveredFilenamesFromCoverage } = require('../../dd-trace/src/plugins/util/test')
+const {
+  getCoveredFilenamesFromCoverage,
+  JEST_WORKER_TRACE_PAYLOAD_CODE,
+  JEST_WORKER_COVERAGE_PAYLOAD_CODE
+} = require('../../dd-trace/src/plugins/util/test')
 
 const testSessionStartCh = channel('ci:jest:session:start')
 const testSessionFinishCh = channel('ci:jest:session:finish')
@@ -12,6 +16,9 @@ const testSessionConfigurationCh = channel('ci:jest:session:configuration')
 const testSuiteStartCh = channel('ci:jest:test-suite:start')
 const testSuiteFinishCh = channel('ci:jest:test-suite:finish')
 
+const workerReportTraceCh = channel('ci:jest:worker-report:trace')
+const workerReportCoverageCh = channel('ci:jest:worker-report:coverage')
+
 const testSuiteCodeCoverageCh = channel('ci:jest:test-suite:code-coverage')
 
 const testStartCh = channel('ci:jest:test:start')
@@ -215,7 +222,6 @@ function cliWrapper (cli, jestVersion) {
         log.error(err)
       }
     }
-
     const isSuitesSkipped = !!skippableSuites.length
 
     const processArgv = process.argv.slice(2).join(' ')
@@ -310,7 +316,6 @@ function jestAdapterWrapper (jestAdapter, jestVersion) {
         } else if (numFailingTests !== 0) {
           status = 'fail'
         }
-        testSuiteFinishCh.publish({ status, errorMessage })
 
         const coverageFiles = getCoveredFilenamesFromCoverage(environment.global.__coverage__)
           .map(filename => getTestSuitePath(filename, environment.rootDir))
@@ -327,6 +332,7 @@ function jestAdapterWrapper (jestAdapter, jestVersion) {
             testSuiteCodeCoverageCh.publish([...coverageFiles, environment.testSuite])
           })
         }
+        testSuiteFinishCh.publish({ status, errorMessage })
         return suiteResults
       })
     })
@@ -477,44 +483,27 @@ addHook({
   file: 'build/jasmineAsyncInstall.js'
 }, jasmineAsyncInstallWraper)
 
-// Maximum time we allow the workers to shutdown
-const JEST_WORKER_SHUTDOWN_TIMEOUT = 20
-// https://github.com/facebook/jest/blob/d6ad15b0f88a05816c2fe034dd6900d28315d570/packages/jest-worker/src/types.ts#L38
-const CHILD_MESSAGE_END = 2
-
-// 25.1.0 is where waitForExit
 addHook({
   name: 'jest-worker',
   versions: ['>=24.9.0'],
-  file: 'build/base/BaseWorkerPool.js'
-}, (baseWorkerPool) => {
-  const BaseWorkerPool = baseWorkerPool.default ? baseWorkerPool.default : baseWorkerPool
-  shimmer.wrap(BaseWorkerPool.prototype, 'end', end => async function () {
-    let timeoutId
-
-    try {
-      // End everything: we listen to this message and attempt to flush everything
-      this._workers.forEach(worker => {
-        worker.send([CHILD_MESSAGE_END], () => {}, () => {}, () => {})
+  file: 'build/workers/ChildProcessWorker.js'
+}, (childProcessWorker) => {
+  const ChildProcessWorker = childProcessWorker.default
+  shimmer.wrap(ChildProcessWorker.prototype, '_onMessage', _onMessage => function () {
+    const [code, data] = arguments[0]
+    if (code === JEST_WORKER_TRACE_PAYLOAD_CODE) { // datadog trace payload
+      sessionAsyncResource.runInAsyncScope(() => {
+        workerReportTraceCh.publish(data)
       })
-
-      const killPromise = new Promise((resolve) => {
-        timeoutId = setTimeout(() => {
-          resolve()
-        }, JEST_WORKER_SHUTDOWN_TIMEOUT * 1000)
+      return
+    }
+    if (code === JEST_WORKER_COVERAGE_PAYLOAD_CODE) { // datadog coverage payload
+      sessionAsyncResource.runInAsyncScope(() => {
+        workerReportCoverageCh.publish(data)
       })
-
-      const workersWaitForExitPromise = Promise.all(this._workers.map(worker =>
-        worker.waitForExit()
-      ))
-
-      // If the workers are able to shut down gracefully before the timeout, we proceed
-      await Promise.race([workersWaitForExitPromise, killPromise])
-      clearTimeout(timeoutId)
-    } catch (e) {
-      // ignore error
+      return
     }
-    return end.apply(this, arguments)
+    return _onMessage.apply(this, arguments)
   })
-  return baseWorkerPool
+  return childProcessWorker
 })

package/packages/datadog-instrumentations/src/ldapjs.js

@@ -35,7 +35,7 @@ function wrapEmitter (corkedEmitter) {
       }
       arguments[1] = bindedFn
     }
-    on.apply(this, arguments)
+    return on.apply(this, arguments)
   }
   shimmer.wrap(corkedEmitter, 'on', addListener)
   shimmer.wrap(corkedEmitter, 'addListener', addListener)
@@ -47,7 +47,7 @@ function wrapEmitter (corkedEmitter) {
         arguments[1] = emitterOn
       }
     }
-    off.apply(this, arguments)
+    return off.apply(this, arguments)
   }
   shimmer.wrap(corkedEmitter, 'off', removeListener)
   shimmer.wrap(corkedEmitter, 'removeListener', removeListener)
@@ -87,5 +87,15 @@ addHook({ name: 'ldapjs', versions: ['>=2'] }, ldapjs => {
     return _send.apply(this, arguments)
   })
 
+  shimmer.wrap(ldapjs.Client.prototype, 'bind', bind => function (dn, password, controls, callback) {
+    if (typeof controls === 'function') {
+      arguments[2] = AsyncResource.bind(controls)
+    } else if (typeof callback === 'function') {
+      arguments[3] = AsyncResource.bind(callback)
+    }
+
+    return bind.apply(this, arguments)
+  })
+
   return ldapjs
 })

package/packages/datadog-instrumentations/src/mongoose.js

@@ -19,7 +19,7 @@ function wrapAddQueue (addQueue) {
 
 addHook({
   name: 'mongoose',
-  versions: ['>=4.6.4']
+  versions: ['>=4.6.4 <7'] // TODO: Mongoose v7 compat
 }, mongoose => {
   if (mongoose.Promise !== global.Promise) {
     shimmer.wrap(mongoose.Promise.prototype, 'then', wrapThen)

package/packages/datadog-instrumentations/src/next.js

@@ -127,7 +127,8 @@ function finish (req, res, result, err) {
   return result
 }
 
-addHook({ name: 'next', versions: ['>=11.1'], file: 'dist/server/next-server.js' }, nextServer => {
+// TODO: 13.2 support
+addHook({ name: 'next', versions: ['>=11.1 <13.2'], file: 'dist/server/next-server.js' }, nextServer => {
   const Server = nextServer.default
 
   shimmer.wrap(Server.prototype, 'handleRequest', wrapHandleRequest)

package/packages/datadog-plugin-amqp10/src/producer.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const ProducerPlugin = require('../../dd-trace/src/plugins/producer')
+const { CLIENT_PORT_KEY } = require('../../dd-trace/src/constants')
 const { getAddress, getShortName } = require('./util')
 
 class Amqp10ProducerPlugin extends ProducerPlugin {
@@ -20,7 +21,7 @@ class Amqp10ProducerPlugin extends ProducerPlugin {
         'amqp.link.target.address': target,
         'amqp.link.role': 'sender',
         'out.host': address.host,
-        'out.port': address.port,
+        [CLIENT_PORT_KEY]: address.port,
         'amqp.link.name': link.name,
         'amqp.link.handle': link.handle,
         'amqp.connection.host': address.host,

package/packages/datadog-plugin-amqplib/src/client.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const { TEXT_MAP } = require('../../../ext/formats')
+const { CLIENT_PORT_KEY } = require('../../dd-trace/src/constants')
 const ClientPlugin = require('../../dd-trace/src/plugins/client')
 const { getResourceName } = require('./util')
 
@@ -19,7 +20,7 @@ class AmqplibClientPlugin extends ClientPlugin {
       kind: 'client',
       meta: {
         'out.host': stream._host,
-        'out.port': stream.remotePort,
+        [CLIENT_PORT_KEY]: stream.remotePort,
         'amqp.queue': fields.queue,
         'amqp.exchange': fields.exchange,
         'amqp.routingKey': fields.routingKey,

package/packages/datadog-plugin-amqplib/src/producer.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const { TEXT_MAP } = require('../../../ext/formats')
+const { CLIENT_PORT_KEY } = require('../../dd-trace/src/constants')
 const ProducerPlugin = require('../../dd-trace/src/plugins/producer')
 const { getResourceName } = require('./util')
 
@@ -18,7 +19,7 @@ class AmqplibProducerPlugin extends ProducerPlugin {
       kind: 'producer',
       meta: {
         'out.host': stream._host,
-        'out.port': stream.remotePort,
+        [CLIENT_PORT_KEY]: stream.remotePort,
         'amqp.queue': fields.queue,
         'amqp.exchange': fields.exchange,
         'amqp.routingKey': fields.routingKey,

package/packages/datadog-plugin-cassandra-driver/src/index.js

@@ -1,5 +1,6 @@
 'use strict'
 
+const { CLIENT_PORT_KEY } = require('../../dd-trace/src/constants')
 const DatabasePlugin = require('../../dd-trace/src/plugins/database')
 
 class CassandraDriverPlugin extends DatabasePlugin {
@@ -21,7 +22,7 @@ class CassandraDriverPlugin extends DatabasePlugin {
         'cassandra.query': query,
         'cassandra.keyspace': keyspace,
         'out.host': connectionOptions.host,
-        'out.port': connectionOptions.port
+        [CLIENT_PORT_KEY]: connectionOptions.port
       }
     })
   }

package/packages/datadog-plugin-cucumber/src/index.js

@@ -36,7 +36,8 @@ class CucumberPlugin extends CiPlugin {
       const testSuiteMetadata = getTestSuiteCommonTags(
         this.command,
         this.frameworkVersion,
-        getTestSuitePath(testSuiteFullPath, this.sourceRoot)
+        getTestSuitePath(testSuiteFullPath, this.sourceRoot),
+        'cucumber'
       )
       this.testSuiteSpan = this.tracer.startSpan('cucumber.test_suite', {
         childOf: this.testModuleSpan,

package/packages/datadog-plugin-cypress/src/plugin.js

@@ -16,6 +16,7 @@ const {
   TEST_SESSION_ID,
   TEST_COMMAND,
   TEST_BUNDLE,
+  TEST_MODULE,
   finishAllTraceSpans
 } = require('../../dd-trace/src/plugins/util/test')
 
@@ -95,8 +96,8 @@ module.exports = (on, config) => {
     command = getCypressCommand(details)
     frameworkVersion = getCypressVersion(details)
 
-    const testSessionSpanMetadata = getTestSessionCommonTags(command, frameworkVersion)
-    const testModuleSpanMetadata = getTestModuleCommonTags(command, frameworkVersion)
+    const testSessionSpanMetadata = getTestSessionCommonTags(command, frameworkVersion, 'cypress')
+    const testModuleSpanMetadata = getTestModuleCommonTags(command, frameworkVersion, 'cypress')
 
     testSessionSpan = tracer.startSpan('cypress.test_session', {
       childOf,
@@ -137,7 +138,7 @@ module.exports = (on, config) => {
       if (testSuiteSpan) {
         return null
       }
-      const testSuiteSpanMetadata = getTestSuiteCommonTags(command, frameworkVersion, suite)
+      const testSuiteSpanMetadata = getTestSuiteCommonTags(command, frameworkVersion, suite, 'cypress')
       testSuiteSpan = tracer.startSpan('cypress.test_suite', {
         childOf: testModuleSpan,
         tags: {
@@ -167,7 +168,8 @@ module.exports = (on, config) => {
         [TEST_COMMAND]: command,
         [TEST_MODULE_ID]: testModuleId,
         [TEST_COMMAND]: command,
-        [TEST_BUNDLE]: command
+        [TEST_BUNDLE]: 'cypress',
+        [TEST_MODULE]: 'cypress'
       }
 
       const {

package/packages/datadog-plugin-google-cloud-pubsub/src/client.js

@@ -6,15 +6,15 @@ class GoogleCloudPubsubClientPlugin extends ClientPlugin {
   static get name () { return 'google-cloud-pubsub' }
   static get operation () { return 'request' }
 
-  start ({ cfg, projectId }) {
-    if (cfg.method === 'publish') return
+  start ({ request, api, projectId }) {
+    if (api === 'publish') return
 
     this.startSpan('pubsub.request', {
       service: this.config.service || `${this.tracer._service}-pubsub`,
-      resource: [cfg.method, cfg.reqOpts.name].filter(x => x).join(' '),
+      resource: [api, request.name].filter(x => x).join(' '),
       kind: 'client',
       meta: {
-        'pubsub.method': cfg.method,
+        'pubsub.method': api,
         'gcloud.project_id': projectId
       }
     })

package/packages/datadog-plugin-google-cloud-pubsub/src/producer.js

@@ -6,17 +6,18 @@ class GoogleCloudPubsubProducerPlugin extends ProducerPlugin {
   static get name () { return 'google-cloud-pubsub' }
   static get operation () { return 'request' }
 
-  start ({ cfg, projectId, messages }) {
-    if (cfg.method !== 'publish') return
+  start ({ request, api, projectId }) {
+    if (api !== 'publish') return
 
-    const topic = cfg.reqOpts.topic
+    const messages = request.messages || []
+    const topic = request.topic
     const span = this.startSpan('pubsub.request', { // TODO: rename
       service: this.config.service || `${this.tracer._service}-pubsub`,
-      resource: `${cfg.method} ${topic}`,
+      resource: `${api} ${topic}`,
       kind: 'producer',
       meta: {
         'gcloud.project_id': projectId,
-        'pubsub.method': cfg.method, // TODO: remove
+        'pubsub.method': api, // TODO: remove
         'pubsub.topic': topic
       }
     })

package/packages/datadog-plugin-http2/src/client.js

@@ -9,7 +9,7 @@ const tags = require('../../../ext/tags')
 const kinds = require('../../../ext/kinds')
 const formats = require('../../../ext/formats')
 const analyticsSampler = require('../../dd-trace/src/analytics_sampler')
-const { COMPONENT } = require('../../dd-trace/src/constants')
+const { COMPONENT, CLIENT_PORT_KEY } = require('../../dd-trace/src/constants')
 const urlFilter = require('../../dd-trace/src/plugins/util/urlfilter')
 
 const HTTP_HEADERS = formats.HTTP_HEADERS
@@ -46,6 +46,7 @@ class Http2ClientPlugin extends Plugin {
         childOf,
         tags: {
           [COMPONENT]: this.constructor.name,
+          [CLIENT_PORT_KEY]: parseInt(sessionDetails.port),
           [SPAN_KIND]: CLIENT,
           'service.name': getServiceName(this.tracer, this.config, sessionDetails),
           'resource.name': method,