dd-trace 2.0.0-appsec-beta.4 → 2.0.1

package/packages/dd-trace/src/opentracing/tracer.js

@@ -7,21 +7,17 @@ const Reference = opentracing.Reference
 const Span = require('./span')
 const SpanContext = require('./span_context')
 const SpanProcessor = require('../span_processor')
-const Sampler = require('../sampler')
 const PrioritySampler = require('../priority_sampler')
 const TextMapPropagator = require('./propagation/text_map')
 const HttpPropagator = require('./propagation/http')
 const BinaryPropagator = require('./propagation/binary')
 const LogPropagator = require('./propagation/log')
-const NoopSpan = require('../noop/span')
 const formats = require('../../../../ext/formats')
 
 const log = require('../log')
-const constants = require('../constants')
 const metrics = require('../metrics')
 const getExporter = require('../exporter')
 
-const REFERENCE_NOOP = constants.REFERENCE_NOOP
 const REFERENCE_CHILD_OF = opentracing.REFERENCE_CHILD_OF
 const REFERENCE_FOLLOWS_FROM = opentracing.REFERENCE_FOLLOWS_FROM
 
@@ -37,12 +33,10 @@ class DatadogTracer extends Tracer {
     this._tags = config.tags
     this._logInjection = config.logInjection
     this._debug = config.debug
-    this._internalErrors = config.experimental.internalErrors
     this._prioritySampler = new PrioritySampler(config.env, config.experimental.sampler)
     this._exporter = new Exporter(config, this._prioritySampler)
     this._processor = new SpanProcessor(this._exporter, this._prioritySampler)
     this._url = this._exporter._url
-    this._sampler = new Sampler(config.sampleRate)
     this._enableGetRumData = config.experimental.enableGetRumData
     this._propagators = {
       [formats.TEXT_MAP]: new TextMapPropagator(config),
@@ -57,20 +51,16 @@ class DatadogTracer extends Tracer {
 
   _startSpan (name, fields) {
     const reference = getParent(fields.references)
-    const type = reference && reference.type()
     const parent = reference && reference.referencedContext()
-    return this._startSpanInternal(name, fields, parent, type)
+    return this._startSpanInternal(name, fields, parent)
   }
 
-  _startSpanInternal (name, fields = {}, parent, type) {
-    if (parent && parent._noop) return parent._noop
-    if (!isSampled(this._sampler, parent, type)) return new NoopSpan(this, parent)
-
+  _startSpanInternal (name, fields = {}, parent) {
     const tags = {
       'service.name': this._service
     }
 
-    const span = new Span(this, this._processor, this._sampler, this._prioritySampler, {
+    const span = new Span(this, this._processor, this._prioritySampler, {
       operationName: fields.operationName || name,
       parent,
       tags,
@@ -121,12 +111,12 @@ function getParent (references = []) {
     const spanContext = ref.referencedContext()
     const type = ref.type()
 
-    if (type !== REFERENCE_NOOP && spanContext && !(spanContext instanceof SpanContext)) {
+    if (spanContext && !(spanContext instanceof SpanContext)) {
       log.error(() => `Expected ${spanContext} to be an instance of SpanContext`)
       continue
     }
 
-    if (type === REFERENCE_CHILD_OF || type === REFERENCE_NOOP) {
+    if (type === REFERENCE_CHILD_OF) {
       parent = ref
       break
     } else if (type === REFERENCE_FOLLOWS_FROM) {
@@ -139,12 +129,4 @@ function getParent (references = []) {
   return parent
 }
 
-function isSampled (sampler, parent, type) {
-  if (type === REFERENCE_NOOP) return false
-  if (parent && !parent._traceFlags.sampled) return false
-  if (!parent && !sampler.isSampled()) return false
-
-  return true
-}
-
 module.exports = DatadogTracer

package/packages/dd-trace/src/plugins/index.js

@@ -4,7 +4,6 @@ module.exports = {
   'amqp10': require('../../../datadog-plugin-amqp10/src'),
   'amqplib': require('../../../datadog-plugin-amqplib/src'),
   'aws-sdk': require('../../../datadog-plugin-aws-sdk/src'),
-  'bluebird': require('../../../datadog-plugin-bluebird/src'),
   'bunyan': require('../../../datadog-plugin-bunyan/src'),
   'cassandra-driver': require('../../../datadog-plugin-cassandra-driver/src'),
   'connect': require('../../../datadog-plugin-connect/src'),
@@ -32,6 +31,7 @@ module.exports = {
   'memcached': require('../../../datadog-plugin-memcached/src'),
   'microgateway-core': require('../../../datadog-plugin-microgateway-core/src'),
   'mocha': require('../../../datadog-plugin-mocha/src'),
+  'moleculer': require('../../../datadog-plugin-moleculer/src'),
   'mongodb-core': require('../../../datadog-plugin-mongodb-core/src'),
   'mongoose': require('../../../datadog-plugin-mongoose/src'),
   'mysql': require('../../../datadog-plugin-mysql/src'),
@@ -42,15 +42,11 @@ module.exports = {
   'paperplane': require('../../../datadog-plugin-paperplane/src'),
   'pg': require('../../../datadog-plugin-pg/src'),
   'pino': require('../../../datadog-plugin-pino/src'),
-  'promise': require('../../../datadog-plugin-promise/src'),
-  'promise-js': require('../../../datadog-plugin-promise-js/src'),
-  'q': require('../../../datadog-plugin-q/src'),
   'redis': require('../../../datadog-plugin-redis/src'),
   'restify': require('../../../datadog-plugin-restify/src'),
   'rhea': require('../../../datadog-plugin-rhea/src'),
   'router': require('../../../datadog-plugin-router/src'),
   'sharedb': require('../../../datadog-plugin-sharedb/src'),
   'tedious': require('../../../datadog-plugin-tedious/src'),
-  'when': require('../../../datadog-plugin-when/src'),
   'winston': require('../../../datadog-plugin-winston/src')
 }

package/packages/dd-trace/src/plugins/plugin.js

@@ -6,7 +6,13 @@ const { storage } = require('../../../datadog-core')
 class Subscription {
   constructor (event, handler) {
     this._channel = dc.channel(event)
-    this._handler = handler
+    this._handler = (message, name) => {
+      const store = storage.getStore()
+
+      if (!store || !store.noop) {
+        handler(message, name)
+      }
+    }
   }
 
   enable () {

package/packages/dd-trace/src/plugins/util/test.js

@@ -24,6 +24,7 @@ const TEST_SUITE = 'test.suite'
 const TEST_STATUS = 'test.status'
 const TEST_PARAMETERS = 'test.parameters'
 const TEST_SKIP_REASON = 'test.skip_reason'
+const TEST_IS_RUM_ACTIVE = 'test.is_rum_active'
 
 const ERROR_TYPE = 'error.type'
 const ERROR_MESSAGE = 'error.msg'
@@ -43,6 +44,7 @@ module.exports = {
   TEST_STATUS,
   TEST_PARAMETERS,
   TEST_SKIP_REASON,
+  TEST_IS_RUM_ACTIVE,
   ERROR_TYPE,
   ERROR_MESSAGE,
   ERROR_STACK,
@@ -54,7 +56,7 @@ module.exports = {
   getTestSuitePath
 }
 
-function getTestEnvironmentMetadata (testFramework) {
+function getTestEnvironmentMetadata (testFramework, config) {
   // TODO: eventually these will come from the tracer (generally available)
   const ciMetadata = getCIMetadata()
   const {
@@ -83,13 +85,17 @@ function getTestEnvironmentMetadata (testFramework) {
 
   const runtimeAndOSMetadata = getRuntimeAndOSMetadata()
 
-  return {
+  const metadata = {
     [TEST_FRAMEWORK]: testFramework,
     ...gitMetadata,
     ...ciMetadata,
     ...userProvidedGitMetadata,
     ...runtimeAndOSMetadata
   }
+  if (config && config.service) {
+    metadata['service.name'] = config.service
+  }
+  return metadata
 }
 
 function getTestParametersString (parametersByTestName, testName) {
@@ -118,8 +124,7 @@ function finishAllTraceSpans (span) {
 function getTestParentSpan (tracer) {
   return tracer.extract('text_map', {
     'x-datadog-trace-id': id().toString(10),
-    'x-datadog-parent-id': '0000000000000000',
-    'x-datadog-sampled': 1
+    'x-datadog-parent-id': '0000000000000000'
   })
 }
 /**

package/packages/dd-trace/src/plugins/util/web.js

@@ -23,6 +23,7 @@ const HTTP_STATUS_CODE = tags.HTTP_STATUS_CODE
 const HTTP_ROUTE = tags.HTTP_ROUTE
 const HTTP_REQUEST_HEADERS = tags.HTTP_REQUEST_HEADERS
 const HTTP_RESPONSE_HEADERS = tags.HTTP_RESPONSE_HEADERS
+const MANUAL_DROP = tags.MANUAL_DROP
 
 const HTTP2_HEADER_AUTHORITY = ':authority'
 const HTTP2_HEADER_SCHEME = ':scheme'
@@ -54,9 +55,8 @@ const web = {
 
     const span = startSpan(tracer, config, req, res, name)
 
-    // TODO: replace this with a REFERENCE_NOOP after we split http/express/etc
     if (!config.filter(req.url)) {
-      span.context()._traceFlags.sampled = false
+      span.setTag(MANUAL_DROP, true)
     }
 
     if (config.service) {
@@ -310,7 +310,7 @@ function addAllowHeaders (req, headers) {
   const contextHeaders = [
     'x-datadog-origin',
     'x-datadog-parent-id',
-    'x-datadog-sampled',
+    'x-datadog-sampled', // Deprecated, but still accept it in case it's sent.
     'x-datadog-sampling-priority',
     'x-datadog-trace-id'
   ]

package/packages/dd-trace/src/profiling/config.js

@@ -20,7 +20,8 @@ const {
   DD_TRACE_AGENT_URL,
   DD_AGENT_HOST,
   DD_TRACE_AGENT_PORT,
-  DD_PROFILING_UPLOAD_TIMEOUT
+  DD_PROFILING_UPLOAD_TIMEOUT,
+  DD_PROFILING_SOURCE_MAP
 } = process.env
 
 class Config {
@@ -34,6 +35,8 @@ class Config {
     const flushInterval = coalesce(options.interval, 65 * 1000)
     const uploadTimeout = coalesce(options.uploadTimeout,
       DD_PROFILING_UPLOAD_TIMEOUT, 60 * 1000)
+    const sourceMap = coalesce(options.sourceMap,
+      DD_PROFILING_SOURCE_MAP, true)
 
     this.enabled = String(enabled) !== 'false'
     this.service = service
@@ -49,6 +52,7 @@ class Config {
     this.logger = ensureLogger(options.logger)
     this.flushInterval = flushInterval
     this.uploadTimeout = uploadTimeout
+    this.sourceMap = sourceMap
 
     const hostname = coalesce(options.hostname, DD_AGENT_HOST, 'localhost')
     const port = coalesce(options.port, DD_TRACE_AGENT_PORT, 8126)

package/packages/dd-trace/src/profiling/exporters/agent.js

@@ -55,7 +55,6 @@ class AgentExporter {
   }
 
   export ({ profiles, start, end, tags }) {
-    const form = new FormData()
     const types = Object.keys(profiles)
 
     const fields = [
@@ -75,10 +74,6 @@ class AgentExporter {
       ...Object.entries(tags).map(([key, value]) => ['tags[]', `${key}:${value}`])
     ]
 
-    for (const [key, value] of fields) {
-      form.append(key, value)
-    }
-
     this._logger.debug(() => {
       const body = fields.map(([key, value]) => `  ${key}: ${value}`).join('\n')
       return `Building agent export report: ${'\n' + body}`
@@ -93,36 +88,14 @@ class AgentExporter {
         return `Adding ${type} profile to agent export: ` + bytes
       })
 
-      form.append(`types[${index}]`, type)
-      form.append(`data[${index}]`, buffer, {
+      fields.push([`types[${index}]`, type])
+      fields.push([`data[${index}]`, buffer, {
         filename: `${type}.pb.gz`,
         contentType: 'application/octet-stream',
         knownLength: buffer.length
-      })
-    }
-
-    const options = {
-      method: 'POST',
-      path: '/profiling/v1/input',
-      headers: form.getHeaders()
-    }
-
-    if (containerId) {
-      options.headers['Datadog-Container-ID'] = containerId
+      }])
     }
 
-    if (this._url.protocol === 'unix:') {
-      options.socketPath = this._url.pathname
-    } else {
-      options.protocol = this._url.protocol
-      options.hostname = this._url.hostname
-      options.port = this._url.port
-    }
-
-    this._logger.debug(() => {
-      return `Submitting agent report to: ${JSON.stringify(options)}`
-    })
-
     return new Promise((resolve, reject) => {
       const operation = retry.operation({
         randomize: true,
@@ -131,8 +104,36 @@ class AgentExporter {
       })
 
       operation.attempt((attempt) => {
-        const timeout = this._backoffTime * Math.pow(2, attempt)
-        sendRequest({ ...options, timeout }, form, (err, response) => {
+        const form = new FormData()
+
+        for (const [key, value, options] of fields) {
+          form.append(key, value, options)
+        }
+
+        const options = {
+          method: 'POST',
+          path: '/profiling/v1/input',
+          headers: form.getHeaders(),
+          timeout: this._backoffTime * Math.pow(2, attempt)
+        }
+
+        if (containerId) {
+          options.headers['Datadog-Container-ID'] = containerId
+        }
+
+        if (this._url.protocol === 'unix:') {
+          options.socketPath = this._url.pathname
+        } else {
+          options.protocol = this._url.protocol
+          options.hostname = this._url.hostname
+          options.port = this._url.port
+        }
+
+        this._logger.debug(() => {
+          return `Submitting profiler agent report attempt #${attempt} to: ${JSON.stringify(options)}`
+        })
+
+        sendRequest(options, form, (err, response) => {
           if (operation.retry(err)) {
             this._logger.error(`Error from the agent: ${err.message}`)
             return

package/packages/dd-trace/src/profiling/profiler.js

@@ -2,7 +2,15 @@
 
 const { EventEmitter } = require('events')
 const { Config } = require('./config')
-const { SourceMapper } = require('./mapper')
+
+function maybeSourceMap (sourceMap) {
+  if (!sourceMap) return
+
+  const { SourceMapper } = require('@datadog/pprof')
+  return SourceMapper.create([
+    process.cwd()
+  ])
+}
 
 class Profiler extends EventEmitter {
   constructor () {
@@ -15,18 +23,21 @@ class Profiler extends EventEmitter {
   }
 
   start (options) {
+    this._start(options).catch(() => {})
+    return this
+  }
+
+  async _start (options) {
     if (this._enabled) return
 
     const config = this._config = new Config(options)
-
     if (!config.enabled) return
 
     this._logger = config.logger
-
     this._enabled = true
 
     try {
-      const mapper = config.sourceMap ? new SourceMapper() : null
+      const mapper = await maybeSourceMap(config.sourceMap)
 
       for (const profiler of config.profilers) {
         // TODO: move this out of Profiler when restoring sourcemap support
@@ -39,8 +50,6 @@ class Profiler extends EventEmitter {
       this._logger.error(e)
       this.stop()
     }
-
-    return this
   }
 
   stop () {

package/packages/dd-trace/src/profiling/profilers/cpu.js

@@ -39,7 +39,7 @@ class NativeCpuProfiler {
 
   _record () {
     this._stop = this._pprof.time.start(this._samplingInterval, null,
-      this._mapper)
+      this._mapper, false)
   }
 }
 

package/packages/dd-trace/src/profiling/profilers/heap.js

@@ -8,13 +8,14 @@ class NativeHeapProfiler {
     this._pprof = undefined
   }
 
-  start () {
+  start ({ mapper } = {}) {
+    this._mapper = mapper
     this._pprof = require('@datadog/pprof')
     this._pprof.heap.start(this._samplingInterval, this._stackDepth)
   }
 
   profile () {
-    return this._pprof.heap.profile()
+    return this._pprof.heap.profile(undefined, this._mapper)
   }
 
   encode (profile) {

package/packages/dd-trace/src/proxy.js

@@ -8,6 +8,7 @@ const Instrumenter = require('./instrumenter')
 const PluginManager = require('./plugin_manager')
 const metrics = require('./metrics')
 const log = require('./log')
+const { isFalse } = require('./util')
 const { setStartupLogInstrumenter } = require('./startup-log')
 
 const noop = new NoopTracer()
@@ -15,6 +16,8 @@ const noop = new NoopTracer()
 class Tracer extends BaseTracer {
   constructor () {
     super()
+
+    this._initialized = false
     this._tracer = noop
     this._instrumenter = new Instrumenter(this)
     this._pluginManager = new PluginManager(this)
@@ -26,41 +29,43 @@ class Tracer extends BaseTracer {
   }
 
   init (options) {
-    if (this._tracer === noop) {
-      try {
-        const config = new Config(options)
-
-        log.use(config.logger)
-        log.toggle(config.debug, config.logLevel, this)
-
-        if (config.hasOwnProperty('profiling') && config.profiling.enabled) {
-          // do not stop tracer initialization if the profiler fails to be imported
-          try {
-            const profiler = require('./profiler')
-            profiler.start(config)
-          } catch (e) {
-            log.error(e)
-          }
-        }
+    if (isFalse(process.env.DD_TRACE_ENABLED) || this._initialized) return this
+
+    this._initialized = true
 
-        if (config.enabled) {
-          if (config.runtimeMetrics) {
-            metrics.start(config)
-          }
+    try {
+      const config = new Config(options) // TODO: support dynamic config
 
-          // dirty require for now so zero appsec code is executed unless explicitly enabled
-          if (config.appsec.enabled) {
-            require('./appsec').enable(config)
-          }
+      log.use(config.logger)
+      log.toggle(config.debug, config.logLevel, this)
 
-          this._tracer = new DatadogTracer(config)
-          this._instrumenter.enable(config)
-          this._pluginManager.configure(config)
-          setStartupLogInstrumenter(this._instrumenter)
+      if (config.profiling.enabled) {
+        // do not stop tracer initialization if the profiler fails to be imported
+        try {
+          const profiler = require('./profiler')
+          profiler.start(config)
+        } catch (e) {
+          log.error(e)
         }
-      } catch (e) {
-        log.error(e)
       }
+
+      if (config.runtimeMetrics) {
+        metrics.start(config)
+      }
+
+      if (config.tracing) {
+        // dirty require for now so zero appsec code is executed unless explicitly enabled
+        if (config.appsec.enabled) {
+          require('./appsec').enable(config)
+        }
+
+        this._tracer = new DatadogTracer(config)
+        this._instrumenter.enable(config)
+        this._pluginManager.configure(config)
+        setStartupLogInstrumenter(this._instrumenter)
+      }
+    } catch (e) {
+      log.error(e)
     }
 
     return this
@@ -115,11 +120,6 @@ class Tracer extends BaseTracer {
     return this._tracer.extract.apply(this._tracer, arguments)
   }
 
-  scopeManager () {
-    this._deprecate('scopeManager')
-    return this._tracer.scopeManager.apply(this._tracer, arguments)
-  }
-
   scope () {
     return this._tracer.scope.apply(this._tracer, arguments)
   }

package/packages/dd-trace/src/span_processor.js

@@ -16,13 +16,6 @@ class SpanProcessor {
 
     if (trace.started.length === trace.finished.length) {
       this._prioritySampler.sample(spanContext)
-
-      if (spanContext._traceFlags.sampled === false) {
-        log.debug(() => `Dropping trace due to user configured filtering: ${trace.started}`)
-        this._erase(trace)
-        return
-      }
-
       const formattedSpans = trace.finished.map(format)
       this._exporter.export(formattedSpans)
       this._erase(trace)

package/packages/dd-trace/src/tracer.js

@@ -2,8 +2,8 @@
 
 const Tracer = require('./opentracing/tracer')
 const tags = require('../../../ext/tags')
-const ScopeManager = require('./scope/noop/scope_manager')
 const Scope = require('./scope')
+const { storage } = require('../../datadog-core')
 const { isError } = require('./util')
 const { setStartupLogConfig } = require('./startup-log')
 
@@ -16,7 +16,6 @@ class DatadogTracer extends Tracer {
   constructor (config) {
     super(config)
 
-    this._scopeManager = new ScopeManager()
     this._scope = new Scope()
     setStartupLogConfig(config)
   }
@@ -68,6 +67,10 @@ class DatadogTracer extends Tracer {
     const tracer = this
 
     return function () {
+      const store = storage.getStore()
+
+      if (store && store.noop) return fn.apply(this, arguments)
+
       let optionsObj = options
       if (typeof optionsObj === 'function' && typeof fn === 'function') {
         optionsObj = optionsObj.apply(this, arguments)
@@ -100,10 +103,6 @@ class DatadogTracer extends Tracer {
     this._exporter.setUrl(url)
   }
 
-  scopeManager () {
-    return this._scopeManager
-  }
-
   scope () {
     return this._scope
   }

package/scripts/install_plugin_modules.js

@@ -25,6 +25,13 @@ Object.keys(externals).forEach(external => externals[external].forEach(thing =>
   }
 }))
 
+fs.readdirSync(path.join(__dirname, '../packages/datadog-instrumentations/src'))
+  .filter(file => file.endsWith('js'))
+  .forEach(file => {
+    file = file.replace('.js', '')
+    plugins[file] = { name: file, prototype: Object.create(Plugin.prototype) }
+  })
+
 run()
 
 async function run () {

package/scripts/publish_docs.js

@@ -18,4 +18,4 @@ exec('git init', { cwd: './docs/out' }) // cloning would overwrite generated doc
 exec('git remote add origin git@github.com:DataDog/dd-trace-js.git', { cwd: './docs/out' })
 exec('git add -A', { cwd: './docs/out' })
 exec(`git commit -m "${msg}"`, { cwd: './docs/out' })
-exec('git push -f origin master:gh-pages', { cwd: './docs/out' })
+exec('git push -f origin main:gh-pages', { cwd: './docs/out' })

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

@@ -1,69 +0,0 @@
-'use strict'
-
-const tx = require('../../dd-trace/src/plugins/util/promise')
-
-const DD_LIB_COPIES = '_datadog_library_copies'
-
-function createGetNewLibraryCopyWrap (tracer, config, originalLib, shim) {
-  return function wrapGetNewLibraryCopy (getNewLibraryCopy) {
-    return function getNewLibraryCopyWithTrace () {
-      const libraryCopy = getNewLibraryCopy.apply(this, arguments)
-      shim.wrap(libraryCopy.prototype, '_then', tx.createWrapThen(tracer, config))
-      shim.wrap(libraryCopy, 'getNewLibraryCopy', createGetNewLibraryCopyWrap(tracer, config, originalLib, shim))
-      addToLibraryCopies(originalLib, libraryCopy)
-      return libraryCopy
-    }
-  }
-}
-
-function addToLibraryCopies (originalLib, libraryCopy) {
-  let libraryCopies = originalLib[DD_LIB_COPIES]
-
-  if (!libraryCopies) {
-    libraryCopies = new Set()
-
-    Object.defineProperty(originalLib, DD_LIB_COPIES, {
-      writable: true,
-      configurable: true,
-      value: libraryCopies
-    })
-  }
-  libraryCopies.add(libraryCopy)
-}
-
-function unwrapLibraryCopies (originalLib, shim) {
-  const libraryCopies = originalLib[DD_LIB_COPIES]
-
-  if (libraryCopies) {
-    libraryCopies.forEach(libraryCopy => {
-      shim.unwrap(libraryCopy.prototype, '_then')
-      shim.unwrap(libraryCopy, 'getNewLibraryCopy')
-    })
-    libraryCopies.clear()
-    delete originalLib[DD_LIB_COPIES]
-  }
-}
-
-module.exports = [
-  {
-    name: 'bluebird',
-    versions: ['^2.11.0', '^3.4.1'],
-    patch (Promise, tracer, config) {
-      this.wrap(Promise, 'getNewLibraryCopy', createGetNewLibraryCopyWrap(tracer, config, Promise, this))
-    },
-    unpatch (Promise) {
-      this.unwrap(Promise, 'getNewLibraryCopy')
-      unwrapLibraryCopies(Promise, this)
-    }
-  },
-  {
-    name: 'bluebird',
-    versions: ['>=2.0.2'], // 2.0.0 and 2.0.1 were removed from npm
-    patch (Promise, tracer, config) {
-      this.wrap(Promise.prototype, '_then', tx.createWrapThen(tracer, config))
-    },
-    unpatch (Promise) {
-      this.unwrap(Promise.prototype, '_then')
-    }
-  }
-]