dd-trace 3.17.1 → 3.18.0

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

@@ -480,6 +480,7 @@ ken|consumer_?(?:id|key|secret)|sign(?:ed|ature)?|auth(?:entication|orization)?)
     this.appsec = {
       enabled: DD_APPSEC_ENABLED,
       rules: DD_APPSEC_RULES ? safeJsonParse(maybeFile(DD_APPSEC_RULES)) : require('./appsec/recommended.json'),
+      customRulesProvided: !!DD_APPSEC_RULES,
       rateLimit: DD_APPSEC_TRACE_RATE_LIMIT,
       wafTimeout: DD_APPSEC_WAF_TIMEOUT,
       obfuscatorKeyRegex: DD_APPSEC_OBFUSCATION_PARAMETER_KEY_REGEXP,

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

@@ -1,5 +1,7 @@
 'use strict'
 
+// TODO: Figure out why we can't use the internal version.
+// eslint-disable-next-line n/no-restricted-require
 const dc = require('diagnostics_channel')
 
 const CHANNEL_PREFIX = 'dd-trace:bundledModuleLoadStart'

package/packages/dd-trace/src/encode/tags-processors.js

@@ -9,8 +9,6 @@ const MAX_META_KEY_LENGTH = 200
 const MAX_META_VALUE_LENGTH = 25000
 // MAX_METRIC_KEY_LENGTH the maximum length of a metric name key
 const MAX_METRIC_KEY_LENGTH = MAX_META_KEY_LENGTH
-// MAX_METRIC_VALUE_LENGTH the maximum length of a metric name value
-const MAX_METRIC_VALUE_LENGTH = MAX_META_VALUE_LENGTH
 
 // From agent normalizer:
 // https://github.com/DataDog/datadog-agent/blob/main/pkg/trace/traceutil/normalize.go
@@ -25,80 +23,55 @@ const MAX_SERVICE_LENGTH = 100
 // MAX_TYPE_LENGTH the maximum length a span type can have
 const MAX_TYPE_LENGTH = 100
 
-const fromEntries = Object.fromEntries || (entries =>
-  entries.reduce((obj, [k, v]) => Object.assign(obj, { [k]: v }), {}))
-
-function truncateToLength (value, maxLength) {
-  if (!value) {
-    return value
-  }
-  if (value.length > maxLength) {
-    return `${value.slice(0, maxLength)}...`
-  }
-  return value
-}
+// TODO (bengl) Pretty much everything in this file should happen in
+// `format.js`, so that we're not iterating over all the spans and modifying
+// them yet again.
 
 // normally the agent truncates the resource and parses it in certain scenarios (e.g. SQL Queries)
 function truncateSpan (span, shouldTruncateResourceName = true) {
-  return fromEntries(Object.entries(span).map(([key, value]) => {
-    switch (key) {
-      case 'resource':
-        return ['resource', shouldTruncateResourceName ? truncateToLength(value, MAX_RESOURCE_NAME_LENGTH) : value]
-      case 'meta':
-        return ['meta', fromEntries(Object.entries(value).map(([metaKey, metaValue]) =>
-          [truncateToLength(metaKey, MAX_META_KEY_LENGTH), truncateToLength(metaValue, MAX_META_VALUE_LENGTH)]
-        ))]
-      case 'metrics':
-        return ['metrics', fromEntries(Object.entries(value).map(([metricsKey, metricsValue]) =>
-          [truncateToLength(metricsKey, MAX_METRIC_KEY_LENGTH), truncateToLength(metricsValue, MAX_METRIC_VALUE_LENGTH)]
-        ))]
-      default:
-        return [key, value]
+  if (shouldTruncateResourceName && span.resource && span.resource.length > MAX_RESOURCE_NAME_LENGTH) {
+    span.resource = `${span.resource.slice(0, MAX_RESOURCE_NAME_LENGTH)}...`
+  }
+  for (let metaKey in span.meta) {
+    const val = span.meta[metaKey]
+    if (metaKey.length > MAX_META_KEY_LENGTH) {
+      delete span.meta[metaKey]
+      metaKey = `${metaKey.slice(0, MAX_META_KEY_LENGTH)}...`
+      span.metrics[metaKey] = val
+    }
+    if (val && val.length > MAX_META_VALUE_LENGTH) {
+      span.meta[metaKey] = `${val.slice(0, MAX_META_VALUE_LENGTH)}...`
+    }
+  }
+  for (let metricsKey in span.metrics) {
+    const val = span.metrics[metricsKey]
+    if (metricsKey.length > MAX_METRIC_KEY_LENGTH) {
+      delete span.metrics[metricsKey]
+      metricsKey = `${metricsKey.slice(0, MAX_METRIC_KEY_LENGTH)}...`
+      span.metrics[metricsKey] = val
     }
-  }))
+  }
+
+  return span
 }
 
 function normalizeSpan (span) {
-  const normalizedSpan = fromEntries(Object.entries(span).map(([key, value]) => {
-    switch (key) {
-      case 'service':
-        if (!value) {
-          return [key, DEFAULT_SERVICE_NAME]
-        }
-        if (value.length > MAX_SERVICE_LENGTH) {
-          return [key, value.slice(0, MAX_SERVICE_LENGTH)]
-        }
-        break
-      case 'name':
-        if (!value) {
-          return [key, DEFAULT_SPAN_NAME]
-        }
-        if (value.length > MAX_NAME_LENGTH) {
-          return [key, value.slice(0, MAX_NAME_LENGTH)]
-        }
-        break
-      case 'resource':
-        if (!value) {
-          return [key, span.name || DEFAULT_SPAN_NAME]
-        }
-        break
-      case 'type':
-        if (!value) {
-          return [key, value]
-        }
-        if (value.length > MAX_TYPE_LENGTH) {
-          return [key, value.slice(0, MAX_TYPE_LENGTH)]
-        }
-    }
-    return [key, value]
-  }))
-  if (!normalizedSpan.service) {
-    normalizedSpan.service = DEFAULT_SERVICE_NAME
+  span.service = span.service || DEFAULT_SERVICE_NAME
+  if (span.service.length > MAX_SERVICE_LENGTH) {
+    span.service = span.service.slice(0, MAX_SERVICE_LENGTH)
   }
-  if (!normalizedSpan.name) {
-    normalizedSpan.name = DEFAULT_SPAN_NAME
+  span.name = span.name || DEFAULT_SPAN_NAME
+  if (span.name.length > MAX_NAME_LENGTH) {
+    span.name = span.name.slice(0, MAX_NAME_LENGTH)
   }
-  return normalizedSpan
+  if (!span.resource) {
+    span.resource = span.name
+  }
+  if (span.type && span.type.length > MAX_TYPE_LENGTH) {
+    span.type = span.type.slice(0, MAX_TYPE_LENGTH)
+  }
+
+  return span
 }
 
 module.exports = {
@@ -107,7 +80,6 @@ module.exports = {
   MAX_META_KEY_LENGTH,
   MAX_META_VALUE_LENGTH,
   MAX_METRIC_KEY_LENGTH,
-  MAX_METRIC_VALUE_LENGTH,
   MAX_NAME_LENGTH,
   MAX_SERVICE_LENGTH,
   MAX_TYPE_LENGTH,

package/packages/dd-trace/src/exporters/common/request.js

@@ -54,13 +54,13 @@ function request (data, options, callback) {
   }
 
   if (options.url) {
-    const url = typeof options.url === 'object' ? options.url : fromUrlString(options.url)
+    const url = typeof options.url === 'object' ? urlToOptions(options.url) : fromUrlString(options.url)
     if (url.protocol === 'unix:') {
       options.socketPath = url.pathname
     } else {
       if (!options.path) options.path = url.path
       options.protocol = url.protocol
-      options.hostname = url.hostname
+      options.hostname = url.hostname // for IPv6 this should be '::1' and not '[::1]'
       options.port = url.port
     }
   }

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

@@ -146,7 +146,8 @@ function extractError (trace, error) {
   trace.error = 1
 
   if (isError(error)) {
-    addTag(trace.meta, trace.metrics, ERROR_MESSAGE, error.message)
+    // AggregateError only has a code and no message.
+    addTag(trace.meta, trace.metrics, ERROR_MESSAGE, error.message || error.code)
     addTag(trace.meta, trace.metrics, ERROR_TYPE, error.name)
     addTag(trace.meta, trace.metrics, ERROR_STACK, error.stack)
   }

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

@@ -3,7 +3,7 @@
 const semver = require('semver')
 const logger = require('./log')
 const { addHook } = require('import-in-the-middle')
-const dc = require('diagnostics_channel')
+const dc = require('../../diagnostics_channel')
 
 if (semver.satisfies(process.versions.node, '>=14.13.1')) {
   const moduleLoadStartChannel = dc.channel('dd-trace:moduleLoadStart')

package/packages/dd-trace/src/log/channels.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const dc = require('diagnostics_channel')
+const { channel } = require('../../../diagnostics_channel')
 
 const Level = {
   Debug: 'debug',
@@ -11,19 +11,18 @@ const Level = {
 
 const defaultLevel = Level.Debug
 
-class LogChannel extends dc.Channel {
-  constructor (name, logLevel) {
-    super(`datadog:log:${name}`)
-    this.logLevel = logLevel
-  }
-}
-
 // based on: https://github.com/trentm/node-bunyan#levels
 const logChannels = {
-  [Level.Debug]: new LogChannel(Level.Debug, 20),
-  [Level.Info]: new LogChannel(Level.Info, 30),
-  [Level.Warn]: new LogChannel(Level.Warn, 40),
-  [Level.Error]: new LogChannel(Level.Error, 50)
+  [Level.Debug]: createLogChannel(Level.Debug, 20),
+  [Level.Info]: createLogChannel(Level.Info, 30),
+  [Level.Warn]: createLogChannel(Level.Warn, 40),
+  [Level.Error]: createLogChannel(Level.Error, 50)
+}
+
+function createLogChannel (name, logLevel) {
+  const logChannel = channel(`datadog:log:${name}`)
+  logChannel.logLevel = logLevel
+  return logChannel
 }
 
 function getChannelLogLevel (level) {

package/packages/dd-trace/src/opentracing/propagation/text_map.js

@@ -343,10 +343,10 @@ class TextMapPropagator {
               spanContext._trace.origin = value
               break
             case 't.dm': {
-              const mechanism = parseInt(value, 10)
+              const mechanism = -Math.abs(parseInt(value, 10))
               if (Number.isInteger(mechanism)) {
                 spanContext._sampling.mechanism = mechanism
-                spanContext._trace.tags['_dd.p.dm'] = mechanism
+                spanContext._trace.tags['_dd.p.dm'] = String(mechanism)
               }
               break
             }

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

@@ -1,6 +1,6 @@
 'use strict'
 
-const { channel } = require('diagnostics_channel')
+const { channel } = require('../../diagnostics_channel')
 const { isFalse } = require('./util')
 const plugins = require('./plugins')
 const log = require('./log')

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

@@ -2,7 +2,7 @@
 
 // TODO: move anything related to tracing to TracingPlugin instead
 
-const dc = require('diagnostics_channel')
+const dc = require('../../../diagnostics_channel')
 const { storage } = require('../../../datadog-core')
 
 class Subscription {

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

@@ -36,6 +36,7 @@ const TEST_SKIP_REASON = 'test.skip_reason'
 const TEST_IS_RUM_ACTIVE = 'test.is_rum_active'
 const TEST_CODE_OWNERS = 'test.codeowners'
 const TEST_SOURCE_FILE = 'test.source.file'
+const TEST_SOURCE_START = 'test.source.start'
 const LIBRARY_VERSION = 'library_version'
 const TEST_COMMAND = 'test.command'
 const TEST_MODULE = 'test.module'
@@ -77,6 +78,7 @@ module.exports = {
   LIBRARY_VERSION,
   JEST_WORKER_TRACE_PAYLOAD_CODE,
   JEST_WORKER_COVERAGE_PAYLOAD_CODE,
+  TEST_SOURCE_START,
   getTestEnvironmentMetadata,
   getTestParametersString,
   finishAllTraceSpans,
@@ -104,7 +106,8 @@ module.exports = {
   getCoveredFilenamesFromCoverage,
   resetCoverage,
   mergeCoverage,
-  fromCoverageMapToCoverage
+  fromCoverageMapToCoverage,
+  getTestLineStart
 }
 
 // Returns pkg manager and its version, separated by '-', e.g. npm-8.15.0 or yarn-1.22.19
@@ -381,3 +384,18 @@ function fromCoverageMapToCoverage (coverageMap) {
     return acc
   }, {})
 }
+
+// Get the start line of a test by inspecting a given error's stack trace
+function getTestLineStart (err, testSuitePath) {
+  if (!err.stack) {
+    return null
+  }
+  // From https://github.com/felixge/node-stack-trace/blob/ba06dcdb50d465cd440d84a563836e293b360427/index.js#L40
+  const testFileLine = err.stack.split('\n').find(line => line.includes(testSuitePath))
+  try {
+    const testFileLineMatch = testFileLine.match(/at (?:(.+?)\s+\()?(?:(.+?):(\d+)(?::(\d+))?|([^)]+))\)?/)
+    return parseInt(testFileLineMatch[3], 10) || null
+  } catch (e) {
+    return null
+  }
+}

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

@@ -2,7 +2,7 @@
 
 const { storage } = require('../../../../datadog-core')
 
-const dc = require('diagnostics_channel')
+const dc = require('../../../../diagnostics_channel')
 
 const beforeCh = dc.channel('dd-trace:storage:before')
 const afterCh = dc.channel('dd-trace:storage:after')

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

@@ -3,7 +3,7 @@
 const path = require('path')
 const Module = require('module')
 const parse = require('module-details-from-path')
-const dc = require('diagnostics_channel')
+const dc = require('../../diagnostics_channel')
 
 const origRequire = Module.prototype.require
 

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

@@ -28,7 +28,7 @@ class SpanAggStats {
   }
 
   record (span) {
-    const durationNs = span._duration * 1e6
+    const durationNs = span.duration
     this.hits++
     this.duration += durationNs
 

package/packages/dd-trace/src/telemetry/dependencies.js

@@ -4,7 +4,7 @@ const path = require('path')
 const parse = require('module-details-from-path')
 const requirePackageJson = require('../require-package-json')
 const { sendData } = require('./send-data')
-const dc = require('diagnostics_channel')
+const dc = require('../../../diagnostics_channel')
 const { fileURLToPath } = require('url')
 
 const savedDependencies = new Set()

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

@@ -1,7 +1,7 @@
 'use strict'
 
 const tracerVersion = require('../../../../package.json').version
-const dc = require('diagnostics_channel')
+const dc = require('../../../diagnostics_channel')
 const os = require('os')
 const dependencies = require('./dependencies')
 const { sendData } = require('./send-data')

package/packages/diagnostics_channel/index.js

@@ -0,0 +1,3 @@
+'use strict'
+
+module.exports = require('./src')

package/packages/diagnostics_channel/src/index.js

@@ -0,0 +1,57 @@
+'use strict'
+
+const {
+  Channel,
+  channel
+} = require('diagnostics_channel') // eslint-disable-line n/no-restricted-require
+
+const [major, minor] = process.versions.node.split('.')
+const channels = new WeakSet()
+
+// Our own DC with a limited subset of functionality stable across Node versions.
+// TODO: Move the rest of the polyfill here.
+// TODO: Switch to using global subscribe/unsubscribe/hasSubscribers.
+const dc = { channel }
+
+// Prevent going to 0 subscribers to avoid bug in Node.
+// See https://github.com/nodejs/node/pull/47520
+if (major === '19' && minor === '9') {
+  dc.channel = function () {
+    const ch = channel.apply(this, arguments)
+
+    if (!channels.has(ch)) {
+      const subscribe = ch.subscribe
+      const unsubscribe = ch.unsubscribe
+
+      ch.subscribe = function () {
+        delete ch.subscribe
+        delete ch.unsubscribe
+
+        const result = subscribe.apply(this, arguments)
+
+        this.subscribe(() => {}) // Keep it active forever.
+
+        return result
+      }
+
+      if (ch.unsubscribe === Channel.prototype.unsubscribe) {
+        // Needed because another subscriber could have subscribed to something
+        // that we unsubscribe to before the library is loaded.
+        ch.unsubscribe = function () {
+          delete ch.subscribe
+          delete ch.unsubscribe
+
+          this.subscribe(() => {}) // Keep it active forever.
+
+          return unsubscribe.apply(this, arguments)
+        }
+      }
+
+      channels.add(ch)
+    }
+
+    return ch
+  }
+}
+
+module.exports = dc

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

@@ -1,203 +0,0 @@
-'use strict'
-
-const shimmer = require('../../datadog-shimmer')
-const log = require('./log')
-const metrics = require('./metrics')
-const Loader = require('./loader')
-const { isTrue } = require('./util')
-const plugins = require('./plugins')
-const Plugin = require('./plugins/plugin')
-const telemetry = require('./telemetry')
-
-const disabledPlugins = process.env.DD_TRACE_DISABLED_PLUGINS
-
-const collectDisabledPlugins = () => {
-  return new Set(disabledPlugins && disabledPlugins.split(',').map(plugin => plugin.trim()))
-}
-
-function cleanEnv (name) {
-  return process.env[`DD_TRACE_${name.toUpperCase()}`.replace(/[^a-z0-9_]/ig, '_')]
-}
-
-function getConfig (name, config = {}) {
-  if (!name) {
-    return config
-  }
-
-  const enabled = cleanEnv(`${name}_ENABLED`)
-  if (enabled !== undefined) {
-    config.enabled = isTrue(enabled)
-  }
-
-  return config
-}
-
-class Instrumenter {
-  constructor (tracer) {
-    this._tracer = tracer
-    this._loader = new Loader(this)
-    this._enabled = false
-    this._names = new Set()
-    this._plugins = new Map()
-    this._instrumented = new Map()
-    this._disabledPlugins = collectDisabledPlugins()
-  }
-
-  use (name, config) {
-    if (typeof name !== 'string') return
-    const plugin = plugins[name.toLowerCase()]
-    if (plugin && plugin.prototype instanceof Plugin) return
-    if (typeof config === 'boolean') {
-      config = { enabled: config }
-    }
-
-    config = getConfig(name, config)
-
-    try {
-      this._set(plugin, { name, config })
-      telemetry.updateIntegrations()
-    } catch (e) {
-      log.debug(`Could not find a plugin named "${name}".`)
-    }
-
-    if (this._enabled) {
-      this._loader.reload(this._plugins)
-    }
-  }
-
-  enable (config) {
-    config = config || {}
-    const serviceMapping = config.serviceMapping
-
-    this._enabled = true
-
-    if (config.plugins !== false) {
-      Object.keys(plugins)
-        .filter(name => !this._plugins.has(plugins[name]))
-        .forEach(name => {
-          if (plugins[name].prototype instanceof Plugin) return
-          const pluginConfig = {}
-          if (serviceMapping && serviceMapping[name]) {
-            pluginConfig.service = serviceMapping[name]
-          }
-          this._set(plugins[name], { name, config: getConfig(name, pluginConfig) })
-        })
-    }
-
-    this._loader.reload(this._plugins)
-  }
-
-  disable () {
-    for (const instrumentation of this._instrumented.keys()) {
-      this.unpatch(instrumentation)
-    }
-
-    this._plugins.clear()
-    this._enabled = false
-    this._loader.reload(this._plugins)
-  }
-
-  wrap (nodules, names, wrapper) {
-    shimmer.massWrap(nodules, names, wrapper)
-  }
-
-  unwrap (nodules, names, wrapper) {
-    shimmer.massUnwrap(nodules, names, wrapper)
-  }
-
-  wrapExport (moduleExports, wrapper) {
-    return shimmer.wrap(moduleExports, wrapper)
-  }
-
-  unwrapExport (moduleExports) {
-    return shimmer.unwrap(moduleExports)
-  }
-
-  load (plugin, meta) {
-    if (!this._enabled) return
-
-    const instrumentations = [].concat(plugin)
-    const enabled = meta.config.enabled !== false
-
-    metrics.boolean(`datadog.tracer.node.plugin.enabled.by.name`, enabled, `name:${meta.name}`)
-
-    try {
-      instrumentations
-        .forEach(instrumentation => {
-          this._loader.load(instrumentation, meta.config)
-        })
-    } catch (e) {
-      log.error(e)
-      this.unload(plugin)
-      log.debug(`Error while trying to patch ${meta.name}. The plugin has been disabled.`)
-
-      metrics.increment(`datadog.tracer.node.plugin.errors`, true)
-    }
-  }
-
-  unload (plugin) {
-    [].concat(plugin)
-      .forEach(instrumentation => {
-        this.unpatch(instrumentation)
-        this._instrumented.delete(instrumentation)
-      })
-
-    const meta = this._plugins.get(plugin)
-
-    if (meta) {
-      this._plugins.delete(plugin)
-
-      metrics.boolean(`datadog.tracer.node.plugin.enabled.by.name`, false, `name:${meta.name}`)
-    }
-  }
-
-  patch (instrumentation, moduleExports, config) {
-    let instrumented = this._instrumented.get(instrumentation)
-
-    if (!instrumented) {
-      this._instrumented.set(instrumentation, instrumented = new Set())
-      telemetry.updateIntegrations()
-    }
-
-    if (!instrumented.has(this._defaultExport(moduleExports))) {
-      try {
-        moduleExports = instrumentation.patch.call(this, moduleExports, this._tracer._tracer, config) || moduleExports
-        return moduleExports
-      } finally {
-        // add even on error since `unpatch` will take care of removing it.
-        instrumented.add(this._defaultExport(moduleExports))
-      }
-    }
-  }
-
-  unpatch (instrumentation) {
-    const instrumented = this._instrumented.get(instrumentation)
-
-    if (instrumented) {
-      instrumented.forEach(moduleExports => {
-        try {
-          instrumentation.unpatch.call(this, moduleExports, this._tracer)
-        } catch (e) {
-          log.error(e)
-        }
-      })
-    }
-  }
-
-  _set (plugin, meta) {
-    if (this._disabledPlugins.has(meta.name)) {
-      log.debug(`Plugin "${meta.name}" was disabled via configuration option.`)
-    } else {
-      this._plugins.set(plugin, meta)
-      this.load(plugin, meta)
-    }
-  }
-
-  // ESM modules have a different export between `import` and `require` so we
-  // use the default export instead when available.
-  _defaultExport (moduleExports) {
-    return moduleExports && (moduleExports.default || moduleExports)
-  }
-}
-
-module.exports = Instrumenter