dd-trace 5.97.0 → 5.99.0

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

@@ -9,7 +9,6 @@ const { getEnvironmentVariable } = require('../../config/helper')
 const satisfies = require('../../../../../vendor/dist/semifies')
 
 const istanbul = require('../../../../../vendor/dist/istanbul-lib-coverage')
-const ignore = require('../../../../../vendor/dist/ignore')
 
 const id = require('../../id')
 const {
@@ -137,6 +136,7 @@ const JEST_WORKER_TRACE_PAYLOAD_CODE = 60
 const JEST_WORKER_COVERAGE_PAYLOAD_CODE = 61
 const JEST_WORKER_LOGS_PAYLOAD_CODE = 62
 const JEST_WORKER_TELEMETRY_PAYLOAD_CODE = 63
+const JEST_WORKER_QUARANTINE_PAYLOAD_CODE = 64
 
 // cucumber worker variables
 const CUCUMBER_WORKER_TRACE_PAYLOAD_CODE = 70
@@ -262,6 +262,7 @@ module.exports = {
   JEST_WORKER_COVERAGE_PAYLOAD_CODE,
   JEST_WORKER_LOGS_PAYLOAD_CODE,
   JEST_WORKER_TELEMETRY_PAYLOAD_CODE,
+  JEST_WORKER_QUARANTINE_PAYLOAD_CODE,
   CUCUMBER_WORKER_TRACE_PAYLOAD_CODE,
   MOCHA_WORKER_TRACE_PAYLOAD_CODE,
   PLAYWRIGHT_WORKER_TRACE_PAYLOAD_CODE,
@@ -669,24 +670,146 @@ function getCodeOwnersFileEntries (rootDir) {
     const trimmed = content.trim()
     if (trimmed === '') continue
     const [pattern, ...owners] = trimmed.split(/\s+/)
-    entries.push({ pattern, owners })
+    entries.push(setCodeOwnersPatternRegex({ pattern, owners }))
   }
   // Reverse because rules defined last take precedence
   return entries.reverse()
 }
 
-const codeOwnersPerFileName = new Map()
+const codeOwnersPerEntries = new WeakMap()
+
+/**
+ * @param {string} character
+ * @returns {string}
+ */
+function escapeRegexCharacter (character) {
+  return character.replaceAll(/[|\\{}()[\]^$+*?.]/g, String.raw`\$&`)
+}
+
+/**
+ * @param {string} pattern
+ * @returns {boolean}
+ */
+function hasUnescapedWildcard (pattern) {
+  for (let i = 0; i < pattern.length; i++) {
+    const character = pattern[i]
+    if (character === '\\') {
+      i++
+    } else if (character === '*' || character === '?') {
+      return true
+    }
+  }
+  return false
+}
+
+/**
+ * @param {string} pattern
+ * @returns {string}
+ */
+function codeOwnersPatternToRegexSource (pattern) {
+  let source = ''
+  for (let i = 0; i < pattern.length; i++) {
+    const character = pattern[i]
+
+    if (character === '\\') {
+      const escapedCharacter = pattern[i + 1]
+      source += escapedCharacter === undefined
+        ? escapeRegexCharacter(character)
+        : escapeRegexCharacter(escapedCharacter)
+      i++
+    } else if (character === '*') {
+      if (pattern[i + 1] === '*') {
+        if (pattern[i + 2] === '/') {
+          source += '(?:.*/)?'
+          i += 2
+        } else {
+          source += '.*'
+          i++
+        }
+      } else {
+        source += '[^/]*'
+      }
+    } else if (character === '?') {
+      source += '[^/]'
+    } else {
+      source += escapeRegexCharacter(character)
+    }
+  }
+  return source
+}
+
+/**
+ * @param {string} pattern
+ * @returns {RegExp|null}
+ */
+function getCodeOwnersPatternRegex (pattern) {
+  if (!pattern || pattern[0] === '!') {
+    return null
+  }
+
+  const directoryOnly = pattern.endsWith('/')
+  const normalizedPattern = pattern.replace(/^\/+/, '').replace(/\/+$/, '')
+  const anchored = pattern.startsWith('/') || normalizedPattern.includes('/')
+
+  if (!normalizedPattern) {
+    return null
+  }
+
+  const lastSlashIndex = normalizedPattern.lastIndexOf('/')
+  const lastSegment = lastSlashIndex === -1 ? normalizedPattern : normalizedPattern.slice(lastSlashIndex + 1)
+  const descendantSuffix = directoryOnly || !hasUnescapedWildcard(lastSegment) ? '(?:/.*)?' : ''
+  const patternSource = codeOwnersPatternToRegexSource(normalizedPattern)
+  const regexSource = anchored
+    ? `^${patternSource}${descendantSuffix}$`
+    : `(?:^|/)${patternSource}${descendantSuffix}$`
+
+  return new RegExp(regexSource)
+}
+
+function setCodeOwnersPatternRegex (entry) {
+  Object.defineProperty(entry, 'regex', {
+    configurable: true,
+    value: getCodeOwnersPatternRegex(entry.pattern),
+    writable: true,
+  })
+  return entry
+}
+
+/**
+ * Match a repository-relative filename against a CODEOWNERS pattern.
+ * See GitHub's CODEOWNERS pattern rules:
+ * https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
+ *
+ * @param {RegExp|null} regex
+ * @param {string} filename
+ * @returns {boolean}
+ */
+function isCodeOwnersPatternMatch (regex, filename) {
+  if (!regex || !filename) {
+    return false
+  }
+
+  const normalizedFilename = filename.replaceAll('\\', '/').replace(/^\/+/, '')
+  return regex.test(normalizedFilename)
+}
 
 function getCodeOwnersForFilename (filename, entries) {
   if (!entries) {
     return null
   }
-  if (codeOwnersPerFileName.has(filename)) {
+  let codeOwnersPerFileName = codeOwnersPerEntries.get(entries)
+
+  if (!codeOwnersPerFileName) {
+    codeOwnersPerFileName = new Map()
+    codeOwnersPerEntries.set(entries, codeOwnersPerFileName)
+  } else if (codeOwnersPerFileName.has(filename)) {
     return codeOwnersPerFileName.get(filename)
   }
+
   for (const entry of entries) {
     try {
-      const isResponsible = ignore().add(entry.pattern).ignores(filename)
+      const regex = entry.regex === undefined ? setCodeOwnersPatternRegex(entry).regex : entry.regex
+      const isResponsible = isCodeOwnersPatternMatch(regex, filename)
       if (isResponsible) {
         const codeOwners = JSON.stringify(entry.owners)
         codeOwnersPerFileName.set(filename, codeOwners)

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

@@ -31,7 +31,8 @@ function extractURL (req) {
 }
 
 function getProtocol (req) {
-  return (req.socket?.encrypted || req.connection?.encrypted) ? 'https' : 'http'
+  // Do not check deprecated `req.connection` property.
+  return req.socket?.encrypted ? 'https' : 'http'
 }
 
 /**

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

@@ -7,8 +7,9 @@ const log = require('../../log')
 const tags = require('../../../../../ext/tags')
 const types = require('../../../../../ext/types')
 const kinds = require('../../../../../ext/kinds')
-const { ERROR_MESSAGE, ERROR_TYPE, ERROR_STACK } = require('../../constants')
+const { ERROR_MESSAGE } = require('../../constants')
 const TracingPlugin = require('../tracing')
+const { storage } = require('../../../../datadog-core')
 const urlFilter = require('./urlfilter')
 const { createInferredProxySpan, finishInferredProxySpan } = require('./inferred_proxy')
 const { extractURL, obfuscateQs, calculateHttpEndpoint } = require('./url')
@@ -125,33 +126,13 @@ const web = {
     context.tracer = tracer
     context.span = span
     context.res = res
+    context.store = storage('legacy').getStore()
 
     this.setConfig(req, config)
     addRequestTags(context, this.TYPE)
 
     return span
   },
-  wrap (req) {
-    const context = contexts.get(req)
-    if (!context.instrumented) {
-      this.wrapEnd(context)
-      context.instrumented = true
-    }
-  },
-  // Start a span and activate a scope for a request.
-  instrument (tracer, config, req, res, name, callback) {
-    const span = this.startSpan(tracer, config, req, res, name)
-
-    this.wrap(req)
-
-    return callback && tracer.scope().activate(span, () => callback(span))
-  },
-
-  // Reactivate the request scope in case it was changed by a middleware.
-  reactivate (req, fn) {
-    return reactivate(req, fn)
-  },
-
   // Add a route segment that will be used for the resource name.
   enterRoute (req, path) {
     if (typeof path === 'string') {
@@ -172,61 +153,6 @@ const web = {
     contexts.get(req).paths.pop()
   },
 
-  // Start a new middleware span and activate a new scope with the span.
-  wrapMiddleware (req, middleware, name, fn) {
-    if (!this.active(req)) return fn()
-
-    const context = contexts.get(req)
-    const tracer = context.tracer
-    const childOf = this.active(req)
-    const config = context.config
-    const traceCtx = context.traceCtx
-
-    if (config.middleware === false) return this.bindAndWrapMiddlewareErrors(fn, req, tracer, childOf)
-
-    const span = startSpanHelper(tracer, name, { childOf }, traceCtx, config)
-
-    analyticsSampler.sample(span, config.measured)
-
-    span.addTags({
-      [RESOURCE_NAME]: middleware._name || middleware.name || '<anonymous>',
-    })
-
-    context.middleware.push(span)
-
-    return tracer.scope().activate(span, fn)
-  },
-
-  // catch errors and apply to active span
-  bindAndWrapMiddlewareErrors (fn, req, tracer, activeSpan) {
-    try {
-      return tracer.scope().bind(fn, activeSpan).apply(this, arguments)
-    } catch (e) {
-      web.addError(req, e) // TODO: remove when error formatting is moved to Span
-      throw e
-    }
-  },
-
-  // Finish the active middleware span.
-  finish (req, error) {
-    if (!this.active(req)) return
-
-    const context = contexts.get(req)
-    const span = context.middleware.pop()
-
-    if (span) {
-      if (error) {
-        span.addTags({
-          [ERROR_TYPE]: error.name,
-          [ERROR_MESSAGE]: error.message,
-          [ERROR_STACK]: error.stack,
-        })
-      }
-
-      span.finish()
-    }
-  },
-
   // Register a callback to run before res.end() is called.
   beforeEnd (req, callback) {
     contexts.get(req).beforeEnd.push(callback)
@@ -278,7 +204,6 @@ const web = {
   startServerlessSpanWithInferredProxy (tracer, config, name, req, traceCtx) {
     const headers = req.headers
     const reqCtx = contexts.get(req)
-    const { storage } = require('../../../../datadog-core')
     const store = storage('legacy').getStore()
     const pubsubSpan = store?.span?._name === 'pubsub.push.receive' ? store.span : null
 
@@ -391,7 +316,6 @@ const web = {
     }
   },
   wrapEnd (context) {
-    const scope = context.tracer.scope()
     const req = context.req
     const res = context.res
     const end = res.end
@@ -406,7 +330,9 @@ const web = {
         return ends.get(this)
       },
       set (value) {
-        ends.set(this, scope.bind(value, context.span))
+        ends.set(this, function () {
+          return storage('legacy').run(context.store, value, ...arguments)
+        })
       },
     })
   },
@@ -453,14 +379,6 @@ function splitHeader (str) {
   return typeof str === 'string' ? str.split(/\s*,\s*/) : []
 }
 
-function reactivate (req, fn) {
-  const context = contexts.get(req)
-
-  return context
-    ? context.tracer.scope().activate(context.span, fn)
-    : fn()
-}
-
 function addRequestTags (context, spanType) {
   const { req, span, inferredProxySpan, config } = context
   const url = extractURL(req)

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

@@ -12,12 +12,6 @@ const { isWebServerSpan, endpointNameFromTags, getStartedSpans } = require('./we
 const profileSubmittedChannel = dc.channel('datadog:profiling:profile-submitted')
 const spanFinishedChannel = dc.channel('dd-trace:span:finish')
 
-function logError (logger, ...args) {
-  if (logger) {
-    logger.error(...args)
-  }
-}
-
 function findWebSpan (startedSpans, spanId) {
   for (let i = startedSpans.length; --i >= 0;) {
     const ispan = startedSpans[i]
@@ -71,33 +65,6 @@ class Profiler extends EventEmitter {
     return this.#config?.flushInterval
   }
 
-  /**
-   * @param {import('../config/config-base')} config - Tracer configuration
-   */
-  start (config) {
-    // TODO: Unify with main logger and rewrite template strings to use printf formatting.
-    const logger = {
-      debug: log.debug.bind(log),
-      info: log.info.bind(log),
-      warn: log.warn.bind(log),
-      error: log.error.bind(log),
-    }
-
-    // TODO: Rewrite this to not need to copy the config.
-    const options = {
-      ...config,
-      logger,
-    }
-
-    try {
-      return this._start(options)
-    } catch (err) {
-      logError(logger, 'Error starting profiler. For troubleshooting tips, see ' +
-        '<https://dtdg.co/nodejs-profiler-troubleshooting>', err)
-      return false
-    }
-  }
-
   get enabled () {
     return this.#enabled
   }
@@ -141,10 +108,6 @@ class Profiler extends EventEmitter {
     return fn()
   }
 
-  #logError (err) {
-    logError(this.#logger, err)
-  }
-
   #getCompressionFn () {
     if (!this.#compressionFnInitialized) {
       this.#compressionFnInitialized = true
@@ -181,8 +144,8 @@ class Profiler extends EventEmitter {
             }
             break
         }
-      } catch (err) {
-        this.#logError(err)
+      } catch (error) {
+        log.error(error)
       }
     }
     return this.#compressionFn
@@ -191,41 +154,36 @@ class Profiler extends EventEmitter {
   /**
    * @param {import('../config/config-base')} options - Tracer configuration
    */
-  _start (options) {
+  start (options) {
     if (this.enabled) return true
+    this.#enabled = true
 
     const config = this.#config = new Config(options)
-
     this.#logger = config.logger
-    this.#enabled = true
-    this._setInterval()
 
+    this._setInterval()
     // Log errors if the source map finder fails, but don't prevent the rest
     // of the profiler from running without source maps.
     let mapper
-    try {
-      const { setLogger, SourceMapper } = require('@datadog/pprof')
-      setLogger(config.logger)
-
-      if (config.sourceMap) {
-        mapper = new SourceMapper(config.debugSourceMaps)
-        mapper.loadDirectory(process.cwd())
-          .then(() => {
-            if (config.debugSourceMaps) {
-              const count = mapper.infoMap.size
-              this.#logger.debug(() => {
-                return count === 0
-                  ? 'Found no source maps'
-                  : `Found source maps for following files: [${[...mapper.infoMap.keys()].join(', ')}]`
-              })
-            }
-          })
-          .catch((err) => {
-            this.#logError(err)
-          })
-      }
-    } catch (err) {
-      this.#logError(err)
+    const { setLogger, SourceMapper } = require('@datadog/pprof')
+    setLogger(config.logger)
+
+    if (config.sourceMap) {
+      mapper = new SourceMapper(config.debugSourceMaps)
+      mapper.loadDirectory(process.cwd())
+        .then(() => {
+          if (config.debugSourceMaps) {
+            const count = mapper.infoMap.size
+            this.#logger.debug(() => {
+              return count === 0
+                ? 'Found no source maps'
+                : `Found source maps for following files: [${[...mapper.infoMap.keys()].join(', ')}]`
+            })
+          }
+        })
+        .catch((error) => {
+          log.error(error)
+        })
     }
 
     try {
@@ -246,12 +204,13 @@ class Profiler extends EventEmitter {
       }
 
       this._capture(this._timeoutInterval, start)
-      return true
-    } catch (e) {
-      this.#logError(e)
+    } catch (error) {
+      log.error(error)
       this.#stop()
       return false
     }
+
+    return true
   }
 
   #nearOOMExport (profileType, encodedProfile, info) {
@@ -389,10 +348,10 @@ class Profiler extends EventEmitter {
             return `Collected ${profiler.type} profile: ` + profileJson
           })
           hasEncoded = true
-        } catch (err) {
+        } catch (error) {
           // If encoding one of the profile types fails, we should still try to
           // encode and submit the other profile types.
-          this.#logError(err)
+          log.error(error)
         }
       }))
 
@@ -401,8 +360,8 @@ class Profiler extends EventEmitter {
         profileSubmittedChannel.publish()
         this.#logger.debug('Submitted profiles')
       }
-    } catch (err) {
-      this.#logError(err)
+    } catch (error) {
+      log.error(error)
       this.#stop()
     }
   }
@@ -424,10 +383,8 @@ class Profiler extends EventEmitter {
       : undefined
     const exportSpec = { profiles, infos, start, end, tags, endpointCounts, customAttributes }
     const tasks = this.#config.exporters.map(exporter =>
-      exporter.export(exportSpec).catch(err => {
-        if (this.#logger) {
-          this.#logger.warn(err)
-        }
+      exporter.export(exportSpec).catch(error => {
+        log.warn(error)
       })
     )
 

package/packages/dd-trace/src/profiling/profilers/event_plugins/crypto.js

@@ -0,0 +1,32 @@
+'use strict'
+
+const EventPlugin = require('./event')
+
+// Params captured on the instrumentation context that are safe to forward as pprof labels. Must be
+// a subset of the names declared in asyncParamsByMethod in datadog-instrumentations/src/crypto.js.
+const allowedParams = new Set([
+  'algorithm', 'digest', 'iterations', 'keylen', 'offset', 'operation', 'size', 'type',
+])
+
+class CryptoPlugin extends EventPlugin {
+  static id = 'crypto'
+
+  static operation = 'operation'
+
+  static entryType = 'crypto'
+
+  extendEvent (event, ctx) {
+    const detail = {}
+    for (const name of allowedParams) {
+      const value = ctx[name]
+      if (typeof value === 'string' || typeof value === 'number') {
+        detail[name] = value
+      }
+    }
+    event.detail = detail
+
+    return event
+  }
+}
+
+module.exports = CryptoPlugin

package/packages/dd-trace/src/profiling/profilers/event_plugins/zlib.js

@@ -0,0 +1,19 @@
+'use strict'
+
+const EventPlugin = require('./event')
+
+class ZlibPlugin extends EventPlugin {
+  static id = 'zlib'
+
+  static operation = 'operation'
+
+  static entryType = 'zlib'
+
+  extendEvent (event, ctx) {
+    event.detail = { operation: ctx.operation }
+
+    return event
+  }
+}
+
+module.exports = ZlibPlugin

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

@@ -194,13 +194,46 @@ class FilesystemDecorator {
   }
 }
 
+class ZlibDecorator {
+  constructor (stringTable) {
+    this.stringTable = stringTable
+    this.operationNameLabelKey = stringTable.dedup('operation')
+  }
+
+  decorateSample (sampleInput, item) {
+    sampleInput.label.push(labelFromStr(this.stringTable, this.operationNameLabelKey, item.detail.operation))
+  }
+}
+
+class CryptoDecorator {
+  constructor (stringTable) {
+    this.stringTable = stringTable
+  }
+
+  decorateSample (sampleInput, item) {
+    const labels = sampleInput.label
+    const stringTable = this.stringTable
+    for (const [key, value] of Object.entries(item.detail)) {
+      switch (typeof value) {
+        case 'string':
+          labels.push(labelFromStrStr(stringTable, key, value))
+          break
+        case 'number':
+          labels.push(new Label({ key: stringTable.dedup(key), num: value }))
+      }
+    }
+  }
+}
+
 // Keys correspond to PerformanceEntry.entryType, values are constructor
 // functions for type-specific decorators.
 const decoratorTypes = {
+  crypto: CryptoDecorator,
   fs: FilesystemDecorator,
   dns: DNSDecorator,
   gc: GCDecorator,
   net: NetDecorator,
+  zlib: ZlibDecorator,
 }
 
 // Translates performance entries into pprof samples.
@@ -348,12 +381,14 @@ class DatadogInstrumentationEventSource {
   constructor (eventHandler, eventFilter) {
     // List all entries explicitly for bundlers to pick up the require calls correctly.
     const plugins = [
+      require('./event_plugins/crypto'),
       require('./event_plugins/dns_lookup'),
       require('./event_plugins/dns_lookupservice'),
       require('./event_plugins/dns_resolve'),
       require('./event_plugins/dns_reverse'),
       require('./event_plugins/fs'),
       require('./event_plugins/net'),
+      require('./event_plugins/zlib'),
     ]
     this.plugins = plugins.map((Plugin) => {
       return new Plugin(eventHandler, eventFilter)

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

@@ -1,6 +1,5 @@
 'use strict'
 
-const { getValueFromEnvSources } = require('./config/helper')
 const NoopProxy = require('./noop/proxy')
 const DatadogTracer = require('./tracer')
 const getConfig = require('./config')
@@ -213,7 +212,7 @@ class Tracer extends NoopProxy {
         this._testApiManualPlugin.configure({ ...config, enabled: true }, false)
       }
       if (config.ciVisAgentlessLogSubmissionEnabled) {
-        if (getValueFromEnvSources('DD_API_KEY')) {
+        if (config.apiKey) {
           const LogSubmissionPlugin = require('./ci-visibility/log-submission/log-submission-plugin')
           const automaticLogPlugin = new LogSubmissionPlugin(this)
           automaticLogPlugin.configure({ ...config, enabled: true })
@@ -255,10 +254,10 @@ class Tracer extends NoopProxy {
     // do not stop tracer initialization if the profiler fails to be imported
     try {
       return require('./profiler').start(config)
-    } catch (e) {
+    } catch (error) {
       log.error(
         'Error starting profiler. For troubleshooting tips, see <https://dtdg.co/nodejs-profiler-troubleshooting>',
-        e
+        error
       )
       return false
     }