dd-trace 5.98.0 → 5.99.1

package/packages/dd-trace/src/appsec/reporter.js

@@ -3,11 +3,12 @@
 const zlib = require('zlib')
 const dc = require('dc-polyfill')
 
-const { storage } = require('../../../datadog-core')
+const { NETWORK_CLIENT_IP } = require('../../../../ext/tags')
 const web = require('../plugins/util/web')
 const { ipHeaderList } = require('../plugins/util/ip_extractor')
 const { keepTrace } = require('../priority_sampler')
 const { ASM } = require('../standalone/product')
+const { getActiveRequest } = require('./store')
 const {
   incrementWafInitMetric,
   incrementWafUpdatesMetric,
@@ -302,7 +303,7 @@ function reportWafConfigUpdate (product, rcConfigId, diagnostics, wafVersion) {
 
 function reportMetrics (metrics, raspRule, req) {
   if (!req) {
-    req = storage('legacy').getStore()?.req
+    req = getActiveRequest()
   }
   const rootSpan = req && web.root(req)
 
@@ -337,7 +338,7 @@ function reportTruncationMetrics (rootSpan, metrics) {
 
 function reportAttack ({ events: attackData, actions }, req) {
   if (!req) {
-    req = storage('legacy').getStore()?.req
+    req = getActiveRequest()
   }
 
   const rootSpan = web.root(req)
@@ -363,7 +364,7 @@ function reportAttack ({ events: attackData, actions }, req) {
     : '{"triggers":' + attackDataStr + '}'
 
   if (req.socket) {
-    newTags['network.client.ip'] = req.socket.remoteAddress
+    newTags[NETWORK_CLIENT_IP] = req.socket.remoteAddress
   }
 
   rootSpan.addTags(newTags)
@@ -481,7 +482,7 @@ function reportAttributes (attributes, req) {
   if (!attributes) return
 
   if (!req) {
-    req = storage('legacy').getStore()?.req
+    req = getActiveRequest()
   }
 
   const rootSpan = web.root(req)

package/packages/dd-trace/src/appsec/sdk/user_blocking.js

@@ -3,8 +3,9 @@
 const { USER_ID } = require('../addresses')
 const waf = require('../waf')
 const { block, getBlockingAction } = require('../blocking')
-const { storage } = require('../../../../datadog-core')
 const log = require('../../log')
+const web = require('../../plugins/util/web')
+const { getActiveRequest } = require('../store')
 const { setUserTags } = require('./set_user')
 const { getRootSpan } = require('./utils')
 
@@ -32,13 +33,8 @@ function checkUserAndSetUser (tracer, user) {
 }
 
 function blockRequest (tracer, req, res) {
-  if (!req || !res) {
-    const store = storage('legacy').getStore()
-    if (store) {
-      req = req || store.req
-      res = res || store.res
-    }
-  }
+  req ||= getActiveRequest()
+  res ||= req && web.getContext(req)?.res
 
   if (!req || !res) {
     log.warn('[ASM] Requests or response object not available in blockRequest')

package/packages/dd-trace/src/appsec/store.js

@@ -0,0 +1,50 @@
+'use strict'
+
+const { storage } = require('../../../datadog-core')
+
+const legacyStorage = storage('legacy')
+
+const kReq = Symbol('dd-trace.appsec.req')
+
+/**
+ * Return a new legacy-storage clone that weakly references `req`.
+ *
+ * The ref lives on an enumerable symbol key so it survives the
+ * `{ ...store, span }` spreads performed by plugin scope handling,
+ * while still allowing `req` (and therefore `res`) to be garbage
+ * collected once the request is done.
+ *
+ * @param {object|undefined} store
+ * @param {object} req
+ * @returns {object}
+ */
+function withRequest (store, req) {
+  return { ...store, [kReq]: new WeakRef(req) }
+}
+
+/**
+ * Resolve the inbound request attached to a specific legacy store.
+ * Prefer {@link getActiveRequest} unless you already have a store in hand.
+ *
+ * @param {object|undefined} store
+ * @returns {object|undefined}
+ */
+function getRequest (store) {
+  return store?.[kReq]?.deref()
+}
+
+/**
+ * Resolve the inbound request attached to the currently active legacy store.
+ * Shortcut for `getRequest(storage('legacy').getStore())`.
+ *
+ * @returns {object|undefined}
+ */
+function getActiveRequest () {
+  return legacyStorage.getStore()?.[kReq]?.deref()
+}
+
+module.exports = {
+  withRequest,
+  getRequest,
+  getActiveRequest,
+}

package/packages/dd-trace/src/appsec/waf/index.js

@@ -1,12 +1,12 @@
 'use strict'
 
-const { storage } = require('../../../../datadog-core')
 const log = require('../../log')
 const Reporter = require('../reporter')
 const Limiter = require('../../rate_limiter')
 const { keepTrace } = require('../../priority_sampler')
 const { ASM } = require('../../standalone/product')
 const web = require('../../plugins/util/web')
+const { getActiveRequest } = require('../store')
 const { updateRateLimitedMetric } = require('../telemetry')
 
 class WafUpdateError extends Error {
@@ -112,13 +112,11 @@ function removeConfig (configPath) {
 
 function run (data, req, raspRule) {
   if (!req) {
-    const store = storage('legacy').getStore()
-    if (!store || !store.req) {
+    req = getActiveRequest()
+    if (!req) {
       log.warn('[ASM] Request object not available in waf.run')
       return
     }
-
-    req = store.req
   }
 
   const wafContext = waf.wafManager.getWAFContext(req)

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

@@ -3,10 +3,9 @@
 const { storage } = require('../../datadog-core')
 
 /**
- * Spec (API semantics):
- * - OpenTelemetry Baggage API: https://opentelemetry.io/docs/specs/otel/baggage/api/
+ * In-process baggage map stored in async local storage. Frozen on every write.
  *
- * In-process baggage is a string->string map stored in async local storage.
+ * @see https://opentelemetry.io/docs/specs/otel/baggage/api/
  * @typedef {import('../../datadog-core/src/storage').Store<string>} BaggageStore
  */
 
@@ -18,6 +17,8 @@ const baggageStorage =
     /** @type {unknown} */ (storage('baggage'))
   )
 
+const EMPTY_STORE = Object.freeze(/** @type {BaggageStore} */ ({}))
+
 // TODO: Implement metadata https://opentelemetry.io/docs/specs/otel/baggage/api/#set-value
 /**
  * @param {string} key
@@ -25,12 +26,11 @@ const baggageStorage =
  * @param {object} [metadata] Not used yet
  */
 function setBaggageItem (key, value, metadata) {
+  const store = baggageStorage.getStore()
   if (typeof key !== 'string' || typeof value !== 'string' || key === '') {
-    return baggageStorage.getStore() ?? {}
+    return store ?? EMPTY_STORE
   }
-
-  const store = baggageStorage.getStore()
-  const newStore = { ...store, [key]: value }
+  const newStore = Object.freeze({ ...store, [key]: value })
   baggageStorage.enterWith(newStore)
   return newStore
 }
@@ -44,23 +44,26 @@ function getBaggageItem (key) {
 }
 
 function getAllBaggageItems () {
-  return baggageStorage.getStore() ?? {}
+  return baggageStorage.getStore() ?? EMPTY_STORE
 }
 
 /**
- * @param {string} keyToRemove
+ * @param {string} keyToRemove No-op for non-string or empty keys.
  */
 function removeBaggageItem (keyToRemove) {
-  const store = baggageStorage.getStore() ?? {}
+  const store = baggageStorage.getStore() ?? EMPTY_STORE
+  if (typeof keyToRemove !== 'string' || keyToRemove === '') {
+    return store
+  }
   const { [keyToRemove]: _, ...newBaggage } = store
+  Object.freeze(newBaggage)
   baggageStorage.enterWith(newBaggage)
   return newBaggage
 }
 
 function removeAllBaggageItems () {
-  const newContext = /** @type {BaggageStore} */ ({})
-  baggageStorage.enterWith(newContext)
-  return newContext
+  baggageStorage.enterWith(EMPTY_STORE)
+  return EMPTY_STORE
 }
 
 module.exports = {

package/packages/dd-trace/src/ci-visibility/early-flake-detection/get-known-tests.js

@@ -1,9 +1,9 @@
 'use strict'
 
+const getConfig = require('../../config')
 const request = require('../requests/request')
 const id = require('../../id')
 const log = require('../../log')
-const { getValueFromEnvSources } = require('../../config/helper')
 
 const {
   incrementCountMetric,
@@ -151,7 +151,7 @@ function fetchFromApi ({
     options.path = `${evpProxyPrefix}/api/v2/ci/libraries/tests`
     options.headers['X-Datadog-EVP-Subdomain'] = 'api'
   } else {
-    const apiKey = getValueFromEnvSources('DD_API_KEY')
+    const { apiKey } = getConfig()
     if (!apiKey) {
       return done(new Error('Known tests were not fetched because Datadog API key is not defined.'))
     }

package/packages/dd-trace/src/ci-visibility/exporters/agentless/coverage-writer.js

@@ -1,8 +1,8 @@
 'use strict'
+const getConfig = require('../../../config')
 const request = require('../../../exporters/common/request')
 const log = require('../../../log')
 const { safeJSONStringify } = require('../../../exporters/common/util')
-const { getValueFromEnvSources } = require('../../../config/helper')
 
 const { CoverageCIVisibilityEncoder } = require('../../../encode/coverage-ci-visibility')
 const BaseWriter = require('../../../exporters/common/writer')
@@ -29,7 +29,7 @@ class Writer extends BaseWriter {
       path: '/api/v2/citestcov',
       method: 'POST',
       headers: {
-        'dd-api-key': getValueFromEnvSources('DD_API_KEY'),
+        'dd-api-key': getConfig().apiKey,
         ...form.getHeaders(),
       },
       timeout: 15_000,

package/packages/dd-trace/src/ci-visibility/exporters/agentless/di-logs-writer.js

@@ -1,9 +1,9 @@
 'use strict'
+const getConfig = require('../../../config')
 const request = require('../../../exporters/common/request')
 const log = require('../../../log')
 const { safeJSONStringify } = require('../../../exporters/common/util')
 const { JSONEncoder } = require('../../encode/json-encoder')
-const { getValueFromEnvSources } = require('../../../config/helper')
 const { DEBUGGER_INPUT_V1 } = require('../../../debugger/constants')
 
 const BaseWriter = require('../../../exporters/common/writer')
@@ -26,7 +26,7 @@ class DynamicInstrumentationLogsWriter extends BaseWriter {
       path: '/api/v2/logs',
       method: 'POST',
       headers: {
-        'dd-api-key': getValueFromEnvSources('DD_API_KEY'),
+        'dd-api-key': getConfig().apiKey,
         'Content-Type': 'application/json',
       },
       timeout: this.timeout,

package/packages/dd-trace/src/ci-visibility/exporters/agentless/writer.js

@@ -1,8 +1,8 @@
 'use strict'
+const getConfig = require('../../../config')
 const request = require('../../../exporters/common/request')
 const { safeJSONStringify } = require('../../../exporters/common/util')
 const log = require('../../../log')
-const { getValueFromEnvSources } = require('../../../config/helper')
 
 const { AgentlessCiVisibilityEncoder } = require('../../../encode/agentless-ci-visibility')
 const BaseWriter = require('../../../exporters/common/writer')
@@ -30,7 +30,7 @@ class Writer extends BaseWriter {
       path: '/api/v2/citestcycle',
       method: 'POST',
       headers: {
-        'dd-api-key': getValueFromEnvSources('DD_API_KEY'),
+        'dd-api-key': getConfig().apiKey,
         'Content-Type': 'application/msgpack',
       },
       timeout: 15_000,

package/packages/dd-trace/src/ci-visibility/exporters/ci-visibility-exporter.js

@@ -234,7 +234,7 @@ class CiVisibilityExporter extends BufferingExporter {
         testManagementAttemptToFixRetries ?? this._config.testManagementAttemptToFixRetries,
       isImpactedTestsEnabled: isImpactedTestsEnabled && this._config.isImpactedTestsEnabled,
       isCoverageReportUploadEnabled,
-      isKeepingCoverageConfiguration: this._config.isKeepingCoverageConfiguration,
+      DD_TEST_TIA_KEEP_COV_CONFIG: this._config.DD_TEST_TIA_KEEP_COV_CONFIG,
     }
   }
 

package/packages/dd-trace/src/ci-visibility/exporters/git/git_metadata.js

@@ -3,12 +3,11 @@
 const fs = require('fs')
 const path = require('path')
 
+const getConfig = require('../../../config')
 const FormData = require('../../../exporters/common/form-data')
 const request = require('../../../exporters/common/request')
-const { getValueFromEnvSources } = require('../../../config/helper')
 
 const log = require('../../../log')
-const { isFalse } = require('../../../util')
 const {
   getLatestCommits,
   getRepositoryUrl,
@@ -51,7 +50,7 @@ function getCommonRequestOptions (url) {
   return {
     method: 'POST',
     headers: {
-      'dd-api-key': getValueFromEnvSources('DD_API_KEY'),
+      'dd-api-key': getConfig().apiKey,
     },
     timeout: 15_000,
     url,
@@ -288,7 +287,7 @@ function sendGitMetadata (url, { isEvpProxy, evpProxyPrefix }, configRepositoryU
     }
     // Otherwise we unshallow and get commits to upload again
     log.debug('It is shallow clone, unshallowing...')
-    if (!isFalse(getValueFromEnvSources('DD_CIVISIBILITY_GIT_UNSHALLOW_ENABLED'))) {
+    if (getConfig().DD_CIVISIBILITY_GIT_UNSHALLOW_ENABLED) {
       unshallowRepository(false)
     }
 

package/packages/dd-trace/src/ci-visibility/intelligent-test-runner/get-skippable-suites.js

@@ -1,8 +1,8 @@
 'use strict'
 
+const getConfig = require('../../config')
 const request = require('../requests/request')
 const log = require('../../log')
-const { getValueFromEnvSources } = require('../../config/helper')
 const {
   incrementCountMetric,
   distributionMetric,
@@ -120,7 +120,7 @@ function fetchFromApi ({
     options.path = `${evpProxyPrefix}/api/v2/ci/tests/skippable`
     options.headers['X-Datadog-EVP-Subdomain'] = 'api'
   } else {
-    const apiKey = getValueFromEnvSources('DD_API_KEY')
+    const { apiKey } = getConfig()
     if (!apiKey) {
       return done(new Error('Skippable suites were not fetched because Datadog API key is not defined.'))
     }

package/packages/dd-trace/src/ci-visibility/log-submission/log-submission-plugin.js

@@ -2,26 +2,25 @@
 
 const Plugin = require('../../plugins/plugin')
 const log = require('../../log')
-const { getValueFromEnvSources } = require('../../config/helper')
 
 function getWinstonLogSubmissionParameters (config) {
-  const { site, service } = config
+  const { site, service, apiKey, DD_AGENTLESS_LOG_SUBMISSION_URL } = config
 
   const defaultParameters = {
     host: `http-intake.logs.${site}`,
     path: `/api/v2/logs?ddsource=winston&service=${service}`,
     ssl: true,
     headers: {
-      'DD-API-KEY': getValueFromEnvSources('DD_API_KEY'),
+      'DD-API-KEY': apiKey,
     },
   }
 
-  if (!getValueFromEnvSources('DD_AGENTLESS_LOG_SUBMISSION_URL')) {
+  if (!DD_AGENTLESS_LOG_SUBMISSION_URL) {
     return defaultParameters
   }
 
   try {
-    const url = new URL(getValueFromEnvSources('DD_AGENTLESS_LOG_SUBMISSION_URL'))
+    const url = new URL(DD_AGENTLESS_LOG_SUBMISSION_URL)
     return {
       host: url.hostname,
       port: url.port,

package/packages/dd-trace/src/ci-visibility/requests/fs-cache.js

@@ -5,8 +5,8 @@ const path = require('node:path')
 const { createHash } = require('node:crypto')
 const { tmpdir } = require('node:os')
 
+const getConfig = require('../../config')
 const log = require('../../log')
-const { getValueFromEnvSources } = require('../../config/helper')
 
 const CACHE_TTL_MS = 30 * 60 * 1000 // 30 minutes
 const CACHE_LOCK_POLL_MS = 500
@@ -14,13 +14,12 @@ const CACHE_LOCK_TIMEOUT_MS = 120_000 // 2 minutes
 const CACHE_LOCK_HEARTBEAT_MS = 30_000 // 30 seconds
 
 /**
- * Returns whether the filesystem cache is enabled via the env var.
+ * Returns whether the filesystem cache is enabled via config.
  *
  * @returns {boolean}
  */
 function isCacheEnabled () {
-  const { isTrue } = require('../../util')
-  return isTrue(getValueFromEnvSources('DD_EXPERIMENTAL_TEST_REQUESTS_FS_CACHE'))
+  return getConfig().DD_EXPERIMENTAL_TEST_REQUESTS_FS_CACHE
 }
 
 /**

package/packages/dd-trace/src/ci-visibility/requests/get-library-configuration.js

@@ -1,8 +1,8 @@
 'use strict'
 
+const getConfig = require('../../config')
 const id = require('../../id')
 const log = require('../../log')
-const { getValueFromEnvSources } = require('../../config/helper')
 const {
   incrementCountMetric,
   distributionMetric,
@@ -36,6 +36,7 @@ function getLibraryConfiguration ({
   custom,
   tag,
 }, done) {
+  const config = getConfig()
   const options = {
     path: '/api/v2/libraries/tests/services/setting',
     method: 'POST',
@@ -50,11 +51,10 @@ function getLibraryConfiguration ({
     options.path = `${evpProxyPrefix}/api/v2/libraries/tests/services/setting`
     options.headers['X-Datadog-EVP-Subdomain'] = 'api'
   } else {
-    const apiKey = getValueFromEnvSources('DD_API_KEY')
-    if (!apiKey) {
+    if (!config.apiKey) {
       return done(new Error('Request to settings endpoint was not done because Datadog API key is not defined.'))
     }
-    options.headers['dd-api-key'] = apiKey
+    options.headers['dd-api-key'] = config.apiKey
   }
 
   const data = JSON.stringify({
@@ -132,11 +132,11 @@ function getLibraryConfiguration ({
 
         log.debug('Remote settings: %j', settings)
 
-        if (getValueFromEnvSources('DD_CIVISIBILITY_DANGEROUSLY_FORCE_COVERAGE')) {
+        if (config.DD_CIVISIBILITY_DANGEROUSLY_FORCE_COVERAGE) {
           settings.isCodeCoverageEnabled = true
           log.debug('Dangerously set code coverage to true')
         }
-        if (getValueFromEnvSources('DD_CIVISIBILITY_DANGEROUSLY_FORCE_TEST_SKIPPING')) {
+        if (config.DD_CIVISIBILITY_DANGEROUSLY_FORCE_TEST_SKIPPING) {
           settings.isSuitesSkippingEnabled = true
           log.debug('Dangerously set test skipping to true')
         }

package/packages/dd-trace/src/ci-visibility/requests/upload-coverage-report.js

@@ -3,10 +3,10 @@
 const { readFileSync } = require('node:fs')
 const { gzipSync } = require('node:zlib')
 
+const getConfig = require('../../config')
 const FormData = require('../../exporters/common/form-data')
 const request = require('../../exporters/common/request')
 const log = require('../../log')
-const { getValueFromEnvSources } = require('../../config/helper')
 const {
   incrementCountMetric,
   distributionMetric,
@@ -34,7 +34,7 @@ function uploadCoverageReport (
   { filePath, format, testEnvironmentMetadata, url, isEvpProxy, evpProxyPrefix },
   callback
 ) {
-  const apiKey = getValueFromEnvSources('DD_API_KEY')
+  const apiKey = getConfig().apiKey
 
   if (!apiKey && !isEvpProxy) {
     return callback(new Error('DD_API_KEY is required for coverage report upload'))

package/packages/dd-trace/src/ci-visibility/test-management/get-test-management-tests.js

@@ -1,8 +1,8 @@
 'use strict'
 
+const getConfig = require('../../config')
 const request = require('../requests/request')
 const id = require('../../id')
-const { getValueFromEnvSources } = require('../../config/helper')
 const log = require('../../log')
 
 const {
@@ -121,7 +121,7 @@ function fetchFromApi ({
     options.path = `${evpProxyPrefix}/api/v2/test/libraries/test-management/tests`
     options.headers['X-Datadog-EVP-Subdomain'] = 'api'
   } else {
-    const apiKey = getValueFromEnvSources('DD_API_KEY')
+    const { apiKey } = getConfig()
     if (!apiKey) {
       return done(new Error('Test management tests were not fetched because Datadog API key is not defined.'))
     }

package/packages/dd-trace/src/config/config-types.d.ts

@@ -10,11 +10,8 @@ export interface ConfigProperties extends GeneratedConfig {
   }
   commitSHA: string | undefined
   debug: boolean
-  gcpPubSubPushSubscriptionEnabled: boolean
   instrumentationSource: 'manual' | 'ssi'
-  isAzureFunction: boolean
   isCiVisibility: boolean
-  isGCPFunction: boolean
   isServiceNameInferred: boolean
   isServiceUserProvided: boolean
   logger: import('../../../../index').TracerOptions['logger'] | undefined
@@ -22,7 +19,6 @@ export interface ConfigProperties extends GeneratedConfig {
   readonly parsedDdTags: Record<string, string>
   plugins: boolean
   repositoryUrl: string | undefined
-  rules: import('../../../../index').SamplingRule[]
   sampler: {
     rateLimit: number
     rules: import('../../../../index').SamplingRule[]

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

@@ -81,11 +81,8 @@ for (const [name, value] of Object.entries(defaults)) {
  * @param {string} optionName
  */
 function generateTelemetry (value = null, origin, optionName) {
-  const { type, canonicalName = optionName } = configurationsTable[optionName] ?? { type: typeof value }
-  // TODO: Consider adding a preParser hook to the parsers object.
-  if (canonicalName === 'OTEL_RESOURCE_ATTRIBUTES') {
-    value = telemetryTransformers.MAP(value)
-  }
+  const tableEntry = configurationsTable[optionName]
+  const { type, canonicalName = optionName } = tableEntry ?? { type: typeof value }
   // TODO: Should we not send defaults to telemetry to reduce size?
   // TODO: How to handle aliases/actual names in the future? Optional fields? Normalize the name at intake?
   // TODO: Validate that space separated tags are parsed by the backend. Optimizations would be possible with that.
@@ -94,9 +91,12 @@ function generateTelemetry (value = null, origin, optionName) {
     if (telemetryTransformers[type]) {
       value = telemetryTransformers[type](value)
     } else if (typeof value === 'object' && value !== null) {
-      value = value instanceof URL
-        ? String(value)
-        : JSON.stringify(value)
+      // Custom optionsTable entries (no `configurationsTable` row, e.g. `logger`)
+      // hold opaque user-supplied references that may carry cycles, so avoid
+      // traversing them via JSON.stringify.
+      value = tableEntry === undefined
+        ? util.inspect(value, { depth: -1 })
+        : value instanceof URL ? String(value) : JSON.stringify(value)
     } else if (typeof value === 'function') {
       value = value.name || 'function'
     }
@@ -250,7 +250,7 @@ for (const [canonicalName, entries] of Object.entries(supportedConfigurations))
       option.transformer = transformer
     }
     if (entry.configurationNames) {
-      addOption(option, type, entry.configurationNames)
+      addOption(option, entry.configurationNames)
     }
     configurationsTable[canonicalName] = option
 
@@ -287,7 +287,7 @@ for (const [fullPropertyName, alias] of fallbackConfigurations) {
   }
 }
 
-function addOption (option, type, configurationNames) {
+function addOption (option, configurationNames) {
   for (const name of configurationNames) {
     let index = -1
     let lastNestedProperties