dd-trace 5.53.0 → 5.55.0

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

@@ -8,6 +8,7 @@ const dc = require('dc-polyfill')
 const { fileURLToPath } = require('url')
 const { isTrue } = require('../../src/util')
 
+/** @type {Set<string>} */
 const savedDependenciesToSend = new Set()
 const detectedDependencyKeys = new Set()
 const detectedDependencyVersions = new Set()
@@ -15,63 +16,66 @@ const detectedDependencyVersions = new Set()
 const FILE_URI_START = 'file://'
 const moduleLoadStartChannel = dc.channel('dd-trace:moduleLoadStart')
 
-let immediate, config, application, host, initialLoad
+let config, application, host, initialLoad
 let isFirstModule = true
 let getRetryData
 let updateRetryData
 
-function createBatchPayload (payload) {
-  const batchPayload = payload.map(item => {
-    return {
-      request_type: item.reqType,
-      payload: item.payload
-    }
-  })
-
-  return batchPayload
-}
 function waitAndSend (config, application, host) {
-  if (!immediate) {
-    immediate = setImmediate(() => {
-      immediate = null
-      if (savedDependenciesToSend.size > 0) {
-        const dependencies = Array.from(savedDependenciesToSend.values())
-          // if a depencdency is from the initial load, *always* send the event
-          // Otherwise, only send if dependencyCollection is enabled
-          .filter(dep => {
-            const initialLoadModule = isTrue(dep.split(' ')[2])
-            const sendModule = initialLoadModule || (config.telemetry?.dependencyCollection)
-
-            if (!sendModule) savedDependenciesToSend.delete(dep) // we'll never send it
-            return sendModule
-          })
-          .splice(0, 2000) // v2 documentation specifies up to 2000 dependencies can be sent at once
-          .map(pair => {
-            savedDependenciesToSend.delete(pair)
-            const [name, version] = pair.split(' ')
-            return { name, version }
-          })
-        let currPayload
-        const retryData = getRetryData()
-        if (retryData) {
-          currPayload = { reqType: 'app-dependencies-loaded', payload: { dependencies } }
-        } else {
-          if (!dependencies.length) return // no retry data and no dependencies, nothing to send
-          currPayload = { dependencies }
+  setImmediate(() => {
+    if (savedDependenciesToSend.size === 0) {
+      return
+    }
+    const dependencies = []
+    let send = 0
+    for (const dependency of savedDependenciesToSend) {
+      const [name, version, initialLoadModule] = dependency.split(' ')
+      // If a dependency is from the initial load, *always* send the event
+      // Otherwise, only send if dependencyCollection is enabled
+      const sendModule = isTrue(initialLoadModule) || config.telemetry?.dependencyCollection
+
+      savedDependenciesToSend.delete(dependency)
+
+      if (sendModule) {
+        dependencies.push({ name, version })
+        send++
+        if (send === 2000) {
+          // v2 documentation specifies up to 2000 dependencies can be sent at once
+          break
         }
+      }
+    }
 
-        const payload = retryData ? createBatchPayload([currPayload, retryData]) : currPayload
-        const reqType = retryData ? 'message-batch' : 'app-dependencies-loaded'
+    /**
+     * @type { { dependencies: typeof dependencies } | {
+     *   request_type: string,
+     *   payload: typeof dependencies
+     * }[]}
+     */
+    let payload = { dependencies }
+    let reqType = 'app-dependencies-loaded'
+    const retryData = getRetryData()
+
+    if (retryData) {
+      payload = [{
+        request_type: 'app-dependencies-loaded',
+        payload
+      }, {
+        request_type: retryData.reqType,
+        payload: retryData.payload
+      }]
+      reqType = 'message-batch'
+    } else if (!dependencies.length) {
+      // No retry data and no dependencies, nothing to send
+      return
+    }
 
-        sendData(config, application, host, reqType, payload, updateRetryData)
+    sendData(config, application, host, reqType, payload, updateRetryData)
 
-        if (savedDependenciesToSend.size > 0) {
-          waitAndSend(config, application, host)
-        }
-      }
-    })
-    immediate.unref()
-  }
+    if (savedDependenciesToSend.size > 0) {
+      waitAndSend(config, application, host)
+    }
+  }).unref()
 }
 
 function loadAllTheLoadedModules () {
@@ -91,18 +95,18 @@ function onModuleLoad (data) {
 
   if (data) {
     let filename = data.filename
-    if (filename && filename.startsWith(FILE_URI_START)) {
+    if (filename?.startsWith(FILE_URI_START)) {
       try {
         filename = fileURLToPath(filename)
-      } catch (e) {
+      } catch {
         // cannot transform url to path
       }
     }
     const parseResult = filename && parse(filename)
-    const request = data.request || (parseResult && parseResult.name)
-    const dependencyKey = parseResult && parseResult.basedir ? parseResult.basedir : request
+    const request = data.request || parseResult?.name
+    const dependencyKey = parseResult?.basedir ?? request
 
-    if (filename && request && isDependency(filename, request) && !detectedDependencyKeys.has(dependencyKey)) {
+    if (filename && request && isDependency(request) && !detectedDependencyKeys.has(dependencyKey)) {
       detectedDependencyKeys.add(dependencyKey)
 
       if (parseResult) {
@@ -118,7 +122,7 @@ function onModuleLoad (data) {
 
               waitAndSend(config, application, host)
             }
-          } catch (e) {
+          } catch {
             // can not read the package.json, do nothing
           }
         }
@@ -135,20 +139,21 @@ function start (_config = {}, _application, _host, getRetryDataFunction, updateR
   updateRetryData = updateRetryDatafunction
   moduleLoadStartChannel.subscribe(onModuleLoad)
 
-  // try and capture intially loaded modules in the first tick
+  // Try and capture initially loaded modules in the first tick
   // since, ideally, the tracer (and this module) should be loaded first,
   // this should capture any first-tick dependencies
   queueMicrotask(() => { initialLoad = false })
 }
 
-function isDependency (filename, request) {
-  const isDependencyWithSlash = isDependencyWithSeparator(filename, request, '/')
+function isDependency (request) {
+  const isDependencyWithSlash = isDependencyWithSeparator(request, '/')
   if (isDependencyWithSlash && process.platform === 'win32') {
-    return isDependencyWithSeparator(filename, request, path.sep)
+    return isDependencyWithSeparator(request, path.sep)
   }
   return isDependencyWithSlash
 }
-function isDependencyWithSeparator (filename, request, sep) {
+
+function isDependencyWithSeparator (request, sep) {
   return request.indexOf(`..${sep}`) !== 0 &&
     request.indexOf(`.${sep}`) !== 0 &&
     request.indexOf(sep) !== 0 &&

package/packages/dd-trace/src/telemetry/logs/log-collector.js

@@ -1,12 +1,12 @@
 'use strict'
 
 const log = require('../../log')
-const { calculateDDBasePath } = require('../../util')
+const { ddBasePath } = require('../../util')
 
 const logs = new Map() // hash -> log
 
 // NOTE: Is this a reasonable number?
-let maxEntries = 10000
+let maxEntries = 10_000
 let overflowedCount = 0
 
 function hashCode (hashSource) {
@@ -20,9 +20,9 @@ function hashCode (hashSource) {
 
 function createHash (logEntry) {
   const prime = 31
-  let result = ((!logEntry.level) ? 0 : hashCode(logEntry.level))
-  result = (((prime * result) | 0) + ((!logEntry.message) ? 0 : hashCode(logEntry.message))) | 0
-  result = (((prime * result) | 0) + ((!logEntry.stack_trace) ? 0 : hashCode(logEntry.stack_trace))) | 0
+  let result = logEntry.level ? hashCode(logEntry.level) : 0
+  result = (((prime * result) | 0) + (logEntry.message ? hashCode(logEntry.message) : 0)) | 0
+  result = (((prime * result) | 0) + (logEntry.stack_trace ? hashCode(logEntry.stack_trace) : 0)) | 0
   return result
 }
 
@@ -30,7 +30,6 @@ function isValid (logEntry) {
   return logEntry?.level && logEntry.message
 }
 
-const ddBasePath = calculateDDBasePath(__dirname)
 const EOL = '\n'
 const STACK_FRAME_LINE_REGEX = /^\s*at\s/gm
 
@@ -42,7 +41,7 @@ function sanitize (logEntry) {
 
   const firstIndex = stackLines.findIndex(l => l.match(STACK_FRAME_LINE_REGEX))
 
-  const isDDCode = firstIndex > -1 && stackLines[firstIndex].includes(ddBasePath)
+  const isDDCode = firstIndex !== -1 && stackLines[firstIndex].includes(ddBasePath)
   stackLines = stackLines
     .filter((line, index) => (isDDCode && index < firstIndex) || line.includes(ddBasePath))
     .map(line => line.replace(ddBasePath, ''))
@@ -78,11 +77,11 @@ const logCollector = {
         return false
       }
       const hash = createHash(logEntry)
-      if (!logs.has(hash)) {
+      if (logs.has(hash)) {
+        logs.get(hash).count++
+      } else {
         logs.set(hash, logEntry)
         return true
-      } else {
-        logs.get(hash).count++
       }
     } catch (e) {
       log.error('Unable to add log to logCollector: %s', e.message)

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

@@ -19,8 +19,14 @@ function now () {
   return Date.now() / 1e3
 }
 
-function mapToJsonArray (map) {
-  return Array.from(map.values()).map(v => v.toJSON())
+function mapToJsonArray (map, filter) {
+  const array = []
+  for (const value of map.values()) {
+    if (!filter || filter(value)) {
+      array.push(value.toJSON())
+    }
+  }
+  return array
 }
 
 function hasPoints (metric) {
@@ -138,7 +144,7 @@ class RateMetric extends Metric {
 
   track (value = 1) {
     this.rate += value
-    const rate = this.interval ? (this.rate / this.interval) : 0.0
+    const rate = this.interval ? (this.rate / this.interval) : 0
     this.points = [[now(), rate]]
   }
 }
@@ -169,8 +175,7 @@ class MetricsCollection extends Map {
   toJSON () {
     if (!this.size) return
 
-    const series = mapToJsonArray(this)
-      .filter(hasPoints)
+    const series = mapToJsonArray(this, hasPoints)
 
     if (!series.length) return
 

package/packages/dd-trace/src/telemetry/send-data.js

@@ -1,6 +1,7 @@
 const request = require('../exporters/common/request')
 const log = require('../log')
 const { isTrue } = require('../util')
+const { getEnvironmentVariable } = require('../config-helper')
 
 let agentTelemetry = true
 
@@ -36,10 +37,9 @@ function getPayload (payload) {
   // 'logs' request type payload is meant to send library logs to Datadog’s backend.
   if (Array.isArray(payload)) {
     return payload
-  } else {
-    const { logger, tags, serviceMapping, ...trimmedPayload } = payload
-    return trimmedPayload
   }
+  const { logger, tags, serviceMapping, ...trimmedPayload } = payload
+  return trimmedPayload
 }
 
 function sendData (config, application, host, reqType, payload = {}, cb = () => {}) {
@@ -51,7 +51,8 @@ function sendData (config, application, host, reqType, payload = {}, cb = () =>
 
   let url = config.url
 
-  const isCiVisibilityAgentlessMode = isCiVisibility && isTrue(process.env.DD_CIVISIBILITY_AGENTLESS_ENABLED)
+  const isCiVisibilityAgentlessMode = isCiVisibility &&
+                                      isTrue(getEnvironmentVariable('DD_CIVISIBILITY_AGENTLESS_ENABLED'))
 
   if (isCiVisibilityAgentlessMode) {
     try {
@@ -74,7 +75,7 @@ function sendData (config, application, host, reqType, payload = {}, cb = () =>
 
   const data = JSON.stringify({
     api_version: 'v2',
-    naming_schema_version: config.spanAttributeSchema ? config.spanAttributeSchema : '',
+    naming_schema_version: config.spanAttributeSchema ?? '',
     request_type: reqType,
     tracer_time: Math.floor(Date.now() / 1000),
     runtime_id: config.tags['runtime-id'],
@@ -85,14 +86,14 @@ function sendData (config, application, host, reqType, payload = {}, cb = () =>
   })
 
   request(data, options, (error) => {
-    if (error && process.env.DD_API_KEY && config.site) {
+    if (error && getEnvironmentVariable('DD_API_KEY') && config.site) {
       if (agentTelemetry) {
         log.warn('Agent telemetry failed, started agentless telemetry')
         agentTelemetry = false
       }
       // figure out which data center to send to
       const backendUrl = getAgentlessTelemetryEndpoint(config.site)
-      const backendHeader = { ...options.headers, 'DD-API-KEY': process.env.DD_API_KEY }
+      const backendHeader = { ...options.headers, 'DD-API-KEY': getEnvironmentVariable('DD_API_KEY') }
       const backendOptions = {
         ...options,
         url: backendUrl,

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

@@ -22,7 +22,7 @@ let heartbeatTimeout
 let heartbeatInterval
 let extendedInterval
 let integrations
-let configWithOrigin = []
+const configWithOrigin = new Map()
 let retryData = null
 const extendedHeartbeatPayload = {}
 
@@ -113,7 +113,7 @@ function getInstallSignature (config) {
 function appStarted (config) {
   const app = {
     products: getProducts(config),
-    configuration: configWithOrigin
+    configuration: [...configWithOrigin.values()]
   }
   const installSignature = getInstallSignature(config)
   if (installSignature) {
@@ -282,7 +282,7 @@ function stop () {
 }
 
 function updateIntegrations () {
-  if (!config || !config.telemetry.enabled) {
+  if (!config?.telemetry.enabled) {
     return
   }
   const integrations = getIntegrations()
@@ -303,6 +303,27 @@ function formatMapForTelemetry (map) {
     : ''
 }
 
+const nameMapping = {
+  sampleRate: 'DD_TRACE_SAMPLE_RATE',
+  logInjection: 'DD_LOG_INJECTION',
+  headerTags: 'DD_TRACE_HEADER_TAGS',
+  tags: 'DD_TAGS',
+  'sampler.rules': 'DD_TRACE_SAMPLING_RULES',
+  traceEnabled: 'DD_TRACE_ENABLED',
+  url: 'DD_TRACE_AGENT_URL',
+  'sampler.rateLimit': 'DD_TRACE_RATE_LIMIT',
+  queryStringObfuscation: 'DD_TRACE_OBFUSCATION_QUERY_STRING_REGEXP',
+  version: 'DD_VERSION',
+  env: 'DD_ENV',
+  service: 'DD_SERVICE',
+  clientIpHeader: 'DD_TRACE_CLIENT_IP_HEADER',
+  'grpc.client.error.statuses': 'DD_GRPC_CLIENT_ERROR_STATUSES',
+  'grpc.server.error.statuses': 'DD_GRPC_SERVER_ERROR_STATUSES',
+  traceId128BitLoggingEnabled: 'DD_TRACE_128_BIT_TRACEID_LOGGING_ENABLED'
+}
+
+const namesNeedFormatting = new Set(['DD_TAGS', 'peerServiceMapping', 'serviceMapping'])
+
 function updateConfig (changes, config) {
   if (!config.telemetry.enabled) return
   if (changes.length === 0) return
@@ -312,34 +333,11 @@ function updateConfig (changes, config) {
   const application = createAppObject(config)
   const host = createHostObject()
 
-  const nameMapping = {
-    sampleRate: 'DD_TRACE_SAMPLE_RATE',
-    logInjection: 'DD_LOG_INJECTION',
-    headerTags: 'DD_TRACE_HEADER_TAGS',
-    tags: 'DD_TAGS',
-    'sampler.rules': 'DD_TRACE_SAMPLING_RULES',
-    traceEnabled: 'DD_TRACE_ENABLED',
-    url: 'DD_TRACE_AGENT_URL',
-    'sampler.rateLimit': 'DD_TRACE_RATE_LIMIT',
-    queryStringObfuscation: 'DD_TRACE_OBFUSCATION_QUERY_STRING_REGEXP',
-    version: 'DD_VERSION',
-    env: 'DD_ENV',
-    service: 'DD_SERVICE',
-    clientIpHeader: 'DD_TRACE_CLIENT_IP_HEADER',
-    'grpc.client.error.statuses': 'DD_GRPC_CLIENT_ERROR_STATUSES',
-    'grpc.server.error.statuses': 'DD_GRPC_SERVER_ERROR_STATUSES',
-    traceId128BitLoggingEnabled: 'DD_TRACE_128_BIT_TRACEID_LOGGING_ENABLED'
-  }
-
-  const namesNeedFormatting = new Set(['DD_TAGS', 'peerServiceMapping', 'serviceMapping'])
-
-  const configuration = []
-  const names = [] // list of config names whose values have been changed
+  const changed = configWithOrigin.size > 0
 
   for (const change of changes) {
     const name = nameMapping[change.name] || change.name
 
-    names.push(name)
     const { origin, value } = change
     const entry = { name, value, origin }
 
@@ -354,20 +352,14 @@ function updateConfig (changes, config) {
     } else if (Array.isArray(entry.value)) {
       entry.value = value.join(',')
     }
-    configuration.push(entry)
+    configWithOrigin.set(name, entry)
   }
 
-  function isNotModified (entry) {
-    return !names.includes(entry.name)
-  }
-
-  if (!configWithOrigin.length) {
-    configWithOrigin = configuration
-  } else {
+  if (changed) {
     // update configWithOrigin to contain up-to-date full list of config values for app-extended-heartbeat
-    configWithOrigin = configWithOrigin.filter(isNotModified)
-    configWithOrigin = configWithOrigin.concat(configuration)
-    const { reqType, payload } = createPayload('app-client-configuration-change', { configuration })
+    const { reqType, payload } = createPayload('app-client-configuration-change', {
+      configuration: [...configWithOrigin.values()]
+    })
     sendData(config, application, host, reqType, payload, updateRetryData)
   }
 }
@@ -376,13 +368,7 @@ function profilingEnabledToBoolean (profilingEnabled) {
   if (typeof profilingEnabled === 'boolean') {
     return profilingEnabled
   }
-  if (['auto', 'true'].includes(profilingEnabled)) {
-    return true
-  }
-  if (profilingEnabled === 'false') {
-    return false
-  }
-  return undefined
+  return profilingEnabled === 'true' || profilingEnabled === 'auto'
 }
 
 module.exports = {

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

@@ -46,9 +46,7 @@ class DatadogTracer extends Tracer {
   }
 
   trace (name, options, fn) {
-    options = Object.assign({
-      childOf: this.scope().active()
-    }, options)
+    options = { childOf: this.scope().active(), ...options }
 
     const span = this.startSpan(name, options)
 
@@ -76,9 +74,8 @@ class DatadogTracer extends Tracer {
             throw err
           }
         )
-      } else {
-        span.finish()
       }
+      span.finish()
 
       return result
     } catch (e) {
@@ -110,9 +107,8 @@ class DatadogTracer extends Tracer {
 
           return fn.apply(this, arguments)
         })
-      } else {
-        return tracer.trace(name, optionsObj, () => fn.apply(this, arguments))
       }
+      return tracer.trace(name, optionsObj, () => fn.apply(this, arguments))
     }
   }
 

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

@@ -69,10 +69,6 @@ function calculateDDBasePath (dirname) {
   return dirSteps.slice(0, packagesIndex + 1).join(path.sep) + path.sep
 }
 
-function hasOwn (object, prop) {
-  return Object.prototype.hasOwnProperty.call(object, prop)
-}
-
 function normalizeProfilingEnabledValue (configValue) {
   return isTrue(configValue)
     ? 'true'
@@ -86,7 +82,6 @@ module.exports = {
   isFalse,
   isError,
   globMatch,
-  calculateDDBasePath,
-  hasOwn,
+  ddBasePath: calculateDDBasePath(__dirname),
   normalizeProfilingEnabledValue
 }

package/version.js

@@ -1,6 +1,7 @@
 'use strict'
 
 /* eslint-disable no-var */
+/* eslint-disable unicorn/prefer-number-properties */
 
 var ddMatches = require('./package.json').version.match(/^(\d+)\.(\d+)\.(\d+)/)
 var nodeMatches = process.versions.node.match(/^(\d+)\.(\d+)\.(\d+)/)

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

@@ -1,77 +0,0 @@
-'use strict'
-
-const { addHook, channel } = require('./helpers/instrument')
-const shimmer = require('../../datadog-shimmer')
-
-const logChannel = channel('apm:paperplane:log')
-const handleChannel = channel('apm:paperplane:request:handle')
-const routeChannel = channel('apm:paperplane:request:route')
-
-const nodeMajor = Number(process.versions.node.split('.')[0])
-const name = 'paperplane'
-const versions = nodeMajor <= 12 ? ['>=2.3.2'] : nodeMajor <= 14 ? ['>=3.1.1'] : []
-
-const wrapRoute = handler => req => {
-  const { original, route } = req
-
-  if (routeChannel.hasSubscribers) {
-    routeChannel.publish({ req: original, route })
-  }
-
-  return handler(req)
-}
-
-const wrapLogger = logger => record => {
-  const event = { message: record }
-
-  logChannel.publish(event)
-
-  return logger(event.message)
-}
-
-const wrapMount = mount => opts => {
-  const handler = mount(opts)
-
-  return function (req, res) {
-    handleChannel.publish(req)
-
-    return handler.apply(this, arguments)
-  }
-}
-
-const wrapRoutes = routes => handlers => {
-  const traced = {}
-
-  for (const route in handlers) {
-    traced[route] = wrapRoute(handlers[route])
-  }
-
-  return routes(traced)
-}
-
-addHook({ name, versions, file: 'lib/logger.js' }, exports => {
-  shimmer.wrap(exports, 'logger', wrapLogger)
-
-  return exports
-})
-
-addHook({ name, versions, file: 'lib/mount.js' }, exports => {
-  shimmer.wrap(exports, 'mount', wrapMount)
-
-  return exports
-})
-
-addHook({ name, versions, file: 'lib/routes.js' }, exports => {
-  shimmer.wrap(exports, 'routes', wrapRoutes)
-
-  return exports
-})
-
-if (nodeMajor <= 12) {
-  addHook({ name, versions: ['2.3.0 - 2.3.1'] }, paperplane => {
-    shimmer.wrap(paperplane, 'mount', wrapMount)
-    shimmer.wrap(paperplane, 'routes', wrapRoutes)
-
-    return paperplane
-  })
-}

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

@@ -1,25 +0,0 @@
-'use strict'
-
-const Plugin = require('../../dd-trace/src/plugins/plugin')
-const PaperplaneLoggerPlugin = require('./logger')
-const PaperplaneServerPlugin = require('./server')
-
-class PaperplanePlugin extends Plugin {
-  static get id () {
-    return 'paperplane'
-  }
-
-  constructor (...args) {
-    super(...args)
-
-    this.server = new PaperplaneServerPlugin(...args)
-    this.logger = new PaperplaneLoggerPlugin(...args)
-  }
-
-  configure (config) {
-    this.server.configure(config)
-    this.logger.configure(config)
-  }
-}
-
-module.exports = PaperplanePlugin

package/packages/datadog-plugin-paperplane/src/logger.js

@@ -1,11 +0,0 @@
-'use strict'
-
-const LogPlugin = require('../../dd-trace/src/plugins/log_plugin')
-
-class PaperplaneLoggerPlugin extends LogPlugin {
-  static get id () {
-    return 'paperplane'
-  }
-}
-
-module.exports = PaperplaneLoggerPlugin

package/packages/datadog-plugin-paperplane/src/server.js

@@ -1,24 +0,0 @@
-'use strict'
-
-const RouterPlugin = require('../../datadog-plugin-router/src')
-const web = require('../../dd-trace/src/plugins/util/web')
-
-class PaperplaneServerPlugin extends RouterPlugin {
-  static get id () {
-    return 'paperplane'
-  }
-
-  constructor (...args) {
-    super(...args)
-
-    this.addSub('apm:paperplane:request:handle', req => {
-      this.setFramework(req, 'paperplane', this.config)
-    })
-
-    this.addSub('apm:paperplane:request:route', ({ req, route }) => {
-      web.setRoute(req, route)
-    })
-  }
-}
-
-module.exports = PaperplaneServerPlugin