dd-trace 5.53.0 → 5.55.0

package/packages/dd-trace/src/ci-visibility/dynamic-instrumentation/worker/index.js

@@ -75,12 +75,12 @@ breakpointSetChannel.on('message', async (probe) => {
 async function removeBreakpoint (probeId) {
   if (!sessionStarted) {
     // We should not get in this state, but abort if we do, so the code doesn't fail unexpected
-    throw Error(`Cannot remove probe ${probeId}: Debugger not started`)
+    throw new Error(`Cannot remove probe ${probeId}: Debugger not started`)
   }
 
   const breakpointId = probeIdToBreakpointId.get(probeId)
   if (!breakpointId) {
-    throw Error(`Unknown probe id: ${probeId}`)
+    throw new Error(`Unknown probe id: ${probeId}`)
   }
   await session.post('Debugger.removeBreakpoint', { breakpointId })
   probeIdToBreakpointId.delete(probeId)

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

@@ -1,6 +1,7 @@
 const request = require('../../exporters/common/request')
 const id = require('../../id')
 const log = require('../../log')
+const { getEnvironmentVariable } = require('../../config-helper')
 
 const {
   incrementCountMetric,
@@ -36,7 +37,7 @@ function getKnownTests ({
     headers: {
       'Content-Type': 'application/json'
     },
-    timeout: 20000,
+    timeout: 20_000,
     url
   }
 
@@ -48,7 +49,7 @@ function getKnownTests ({
     options.path = `${evpProxyPrefix}/api/v2/ci/libraries/tests`
     options.headers['X-Datadog-EVP-Subdomain'] = 'api'
   } else {
-    const apiKey = process.env.DATADOG_API_KEY || process.env.DD_API_KEY
+    const apiKey = getEnvironmentVariable('DD_API_KEY')
     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/agent-proxy/index.js

@@ -16,17 +16,17 @@ function getLatestEvpProxyVersion (err, agentInfo) {
   return agentInfo.endpoints.reduce((acc, endpoint) => {
     if (endpoint.includes(AGENT_EVP_PROXY_PATH_PREFIX)) {
       const version = Number(endpoint.replace(AGENT_EVP_PROXY_PATH_REGEX, '$1'))
-      if (isNaN(version)) {
+      if (Number.isNaN(version)) {
         return acc
       }
-      return version > acc ? version : acc
+      return Math.max(version, acc)
     }
     return acc
   }, 0)
 }
 
 function getCanForwardDebuggerLogs (err, agentInfo) {
-  return !err && agentInfo.endpoints.some(endpoint => endpoint === AGENT_DEBUGGER_INPUT)
+  return !err && agentInfo.endpoints.includes(AGENT_DEBUGGER_INPUT)
 }
 
 class AgentProxyCiVisibilityExporter extends CiVisibilityExporter {

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

@@ -2,6 +2,7 @@
 const request = require('../../../exporters/common/request')
 const log = require('../../../log')
 const { safeJSONStringify } = require('../../../exporters/common/util')
+const { getEnvironmentVariable } = require('../../../config-helper')
 
 const { CoverageCIVisibilityEncoder } = require('../../../encode/coverage-ci-visibility')
 const BaseWriter = require('../../../exporters/common/writer')
@@ -28,10 +29,10 @@ class Writer extends BaseWriter {
       path: '/api/v2/citestcov',
       method: 'POST',
       headers: {
-        'dd-api-key': process.env.DATADOG_API_KEY || process.env.DD_API_KEY,
+        'dd-api-key': getEnvironmentVariable('DD_API_KEY'),
         ...form.getHeaders()
       },
-      timeout: 15000,
+      timeout: 15_000,
       url: this._url
     }
 

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

@@ -3,6 +3,7 @@ const request = require('../../../exporters/common/request')
 const log = require('../../../log')
 const { safeJSONStringify } = require('../../../exporters/common/util')
 const { JSONEncoder } = require('../../encode/json-encoder')
+const { getEnvironmentVariable } = require('../../../config-helper')
 
 const BaseWriter = require('../../../exporters/common/writer')
 
@@ -23,11 +24,11 @@ class DynamicInstrumentationLogsWriter extends BaseWriter {
       path: '/api/v2/logs',
       method: 'POST',
       headers: {
-        'dd-api-key': process.env.DATADOG_API_KEY || process.env.DD_API_KEY,
+        'dd-api-key': getEnvironmentVariable('DD_API_KEY'),
         'Content-Type': 'application/json'
       },
       // TODO: what's a good value for timeout for the logs intake?
-      timeout: this.timeout || 15000,
+      timeout: this.timeout || 15_000,
       url: this._url
     }
 

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

@@ -2,6 +2,7 @@
 const request = require('../../../exporters/common/request')
 const { safeJSONStringify } = require('../../../exporters/common/util')
 const log = require('../../../log')
+const { getEnvironmentVariable } = require('../../../config-helper')
 
 const { AgentlessCiVisibilityEncoder } = require('../../../encode/agentless-ci-visibility')
 const BaseWriter = require('../../../exporters/common/writer')
@@ -29,10 +30,10 @@ class Writer extends BaseWriter {
       path: '/api/v2/citestcycle',
       method: 'POST',
       headers: {
-        'dd-api-key': process.env.DATADOG_API_KEY || process.env.DD_API_KEY,
+        'dd-api-key': getEnvironmentVariable('DD_API_KEY'),
         'Content-Type': 'application/msgpack'
       },
-      timeout: 15000,
+      timeout: 15_000,
       url: this._url
     }
 

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

@@ -31,7 +31,7 @@ function getIsTestSessionTrace (trace) {
   )
 }
 
-const GIT_UPLOAD_TIMEOUT = 60000 // 60 seconds
+const GIT_UPLOAD_TIMEOUT = 60_000 // 60 seconds
 const CAN_USE_CI_VIS_PROTOCOL_TIMEOUT = GIT_UPLOAD_TIMEOUT
 
 class CiVisibilityExporter extends AgentInfoExporter {
@@ -216,7 +216,8 @@ class CiVisibilityExporter extends AgentInfoExporter {
       isDiEnabled,
       isKnownTestsEnabled,
       isTestManagementEnabled,
-      testManagementAttemptToFixRetries
+      testManagementAttemptToFixRetries,
+      isImpactedTestsEnabled
     } = remoteConfiguration
     return {
       isCodeCoverageEnabled,
@@ -232,7 +233,8 @@ class CiVisibilityExporter extends AgentInfoExporter {
       isKnownTestsEnabled,
       isTestManagementEnabled: isTestManagementEnabled && this._config.isTestManagementEnabled,
       testManagementAttemptToFixRetries:
-        testManagementAttemptToFixRetries ?? this._config.testManagementAttemptToFixRetries
+        testManagementAttemptToFixRetries ?? this._config.testManagementAttemptToFixRetries,
+      isImpactedTestsEnabled: isImpactedTestsEnabled && this._config.isImpactedTestsEnabled
     }
   }
 
@@ -336,7 +338,7 @@ class CiVisibilityExporter extends AgentInfoExporter {
       this._writer,
       this._coverageWriter,
       this._logsWriter
-    ].filter(writer => writer)
+    ].filter(Boolean)
 
     let remaining = writers.length
 

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

@@ -3,6 +3,7 @@ const path = require('path')
 
 const FormData = require('../../../exporters/common/form-data')
 const request = require('../../../exporters/common/request')
+const { getEnvironmentVariable } = require('../../../config-helper')
 
 const log = require('../../../log')
 const { isFalse } = require('../../../util')
@@ -38,7 +39,7 @@ function validateCommits (commits) {
       throw new Error('Invalid commit type response')
     }
     if (isValidSha1(commitSha) || isValidSha256(commitSha)) {
-      return commitSha.replace(/[^0-9a-f]+/g, '')
+      return commitSha.replaceAll(/[^0-9a-f]+/g, '')
     }
     throw new Error('Invalid commit format')
   })
@@ -48,9 +49,9 @@ function getCommonRequestOptions (url) {
   return {
     method: 'POST',
     headers: {
-      'dd-api-key': process.env.DATADOG_API_KEY || process.env.DD_API_KEY
+      'dd-api-key': getEnvironmentVariable('DD_API_KEY')
     },
-    timeout: 15000,
+    timeout: 15_000,
     url
   }
 }
@@ -148,7 +149,7 @@ function uploadPackFile ({ url, isEvpProxy, evpProxyPrefix, packFileToUpload, re
       filename,
       contentType: 'application/octet-stream'
     })
-  } catch (e) {
+  } catch {
     callback(new Error(`Could not read "${packFileToUpload}"`))
     return
   }
@@ -285,7 +286,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(process.env.DD_CIVISIBILITY_GIT_UNSHALLOW_ENABLED)) {
+    if (!isFalse(getEnvironmentVariable('DD_CIVISIBILITY_GIT_UNSHALLOW_ENABLED'))) {
       unshallowRepository()
     }
 

package/packages/dd-trace/src/ci-visibility/exporters/test-worker/index.js

@@ -9,18 +9,19 @@ const {
   JEST_WORKER_LOGS_PAYLOAD_CODE,
   PLAYWRIGHT_WORKER_TRACE_PAYLOAD_CODE
 } = require('../../../plugins/util/test')
+const { getEnvironmentVariable } = require('../../../config-helper')
 
 function getInterprocessTraceCode () {
-  if (process.env.JEST_WORKER_ID) {
+  if (getEnvironmentVariable('JEST_WORKER_ID')) {
     return JEST_WORKER_TRACE_PAYLOAD_CODE
   }
-  if (process.env.CUCUMBER_WORKER_ID) {
+  if (getEnvironmentVariable('CUCUMBER_WORKER_ID')) {
     return CUCUMBER_WORKER_TRACE_PAYLOAD_CODE
   }
-  if (process.env.MOCHA_WORKER_ID) {
+  if (getEnvironmentVariable('MOCHA_WORKER_ID')) {
     return MOCHA_WORKER_TRACE_PAYLOAD_CODE
   }
-  if (process.env.DD_PLAYWRIGHT_WORKER) {
+  if (getEnvironmentVariable('DD_PLAYWRIGHT_WORKER')) {
     return PLAYWRIGHT_WORKER_TRACE_PAYLOAD_CODE
   }
   return null
@@ -28,14 +29,14 @@ function getInterprocessTraceCode () {
 
 // TODO: make it available with cucumber
 function getInterprocessCoverageCode () {
-  if (process.env.JEST_WORKER_ID) {
+  if (getEnvironmentVariable('JEST_WORKER_ID')) {
     return JEST_WORKER_COVERAGE_PAYLOAD_CODE
   }
   return null
 }
 
 function getInterprocessLogsCode () {
-  if (process.env.JEST_WORKER_ID) {
+  if (getEnvironmentVariable('JEST_WORKER_ID')) {
     return JEST_WORKER_LOGS_PAYLOAD_CODE
   }
   return null

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

@@ -25,7 +25,6 @@ class Writer {
   _sendPayload (data, onDone = () => {}) {
     // ## Jest
     // Only available when `child_process` is used for the jest worker.
-    // eslint-disable-next-line
     // https://github.com/facebook/jest/blob/bb39cb2c617a3334bf18daeca66bd87b7ccab28b/packages/jest-worker/README.md#experimental-worker
     // If worker_threads is used, this will not work
     // TODO: make it compatible with worker_threads
@@ -33,7 +32,6 @@ class Writer {
     // ## Cucumber
     // This reports to the test's main process the same way test data is reported by Cucumber
     // See cucumber code:
-    // eslint-disable-next-line
     // https://github.com/cucumber/cucumber-js/blob/5ce371870b677fe3d1a14915dc535688946f734c/src/runtime/parallel/run_worker.ts#L13
     if (process.send) { // it only works if process.send is available
       process.send([this._interprocessCode, data], () => {

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

@@ -1,5 +1,6 @@
 const request = require('../../exporters/common/request')
 const log = require('../../log')
+const { getEnvironmentVariable } = require('../../config-helper')
 const {
   incrementCountMetric,
   distributionMetric,
@@ -34,7 +35,7 @@ function getSkippableSuites ({
     headers: {
       'Content-Type': 'application/json'
     },
-    timeout: 20000,
+    timeout: 20_000,
     url
   }
 
@@ -46,7 +47,7 @@ function getSkippableSuites ({
     options.path = `${evpProxyPrefix}/api/v2/ci/tests/skippable`
     options.headers['X-Datadog-EVP-Subdomain'] = 'api'
   } else {
-    const apiKey = process.env.DATADOG_API_KEY || process.env.DD_API_KEY
+    const apiKey = getEnvironmentVariable('DD_API_KEY')
     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

@@ -1,5 +1,6 @@
 const Plugin = require('../../plugins/plugin')
 const log = require('../../log')
+const { getEnvironmentVariable } = require('../../config-helper')
 
 function getWinstonLogSubmissionParameters (config) {
   const { site, service } = config
@@ -9,16 +10,16 @@ function getWinstonLogSubmissionParameters (config) {
     path: `/api/v2/logs?ddsource=winston&service=${service}`,
     ssl: true,
     headers: {
-      'DD-API-KEY': process.env.DD_API_KEY
+      'DD-API-KEY': getEnvironmentVariable('DD_API_KEY')
     }
   }
 
-  if (!process.env.DD_AGENTLESS_LOG_SUBMISSION_URL) {
+  if (!getEnvironmentVariable('DD_AGENTLESS_LOG_SUBMISSION_URL')) {
     return defaultParameters
   }
 
   try {
-    const url = new URL(process.env.DD_AGENTLESS_LOG_SUBMISSION_URL)
+    const url = new URL(getEnvironmentVariable('DD_AGENTLESS_LOG_SUBMISSION_URL'))
     return {
       host: url.hostname,
       port: url.port,
@@ -26,7 +27,7 @@ function getWinstonLogSubmissionParameters (config) {
       path: defaultParameters.path,
       headers: defaultParameters.headers
     }
-  } catch (e) {
+  } catch {
     log.error('Could not parse DD_AGENTLESS_LOG_SUBMISSION_URL')
     return defaultParameters
   }

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

@@ -1,6 +1,7 @@
 const request = require('../../exporters/common/request')
 const id = require('../../id')
 const log = require('../../log')
+const { getEnvironmentVariable } = require('../../config-helper')
 const {
   incrementCountMetric,
   distributionMetric,
@@ -28,7 +29,8 @@ function getLibraryConfiguration ({
   runtimeVersion,
   branch,
   testLevel = 'suite',
-  custom
+  custom,
+  tag
 }, done) {
   const options = {
     path: '/api/v2/libraries/tests/services/setting',
@@ -37,14 +39,14 @@ function getLibraryConfiguration ({
       'Content-Type': 'application/json'
     },
     url,
-    timeout: 20000
+    timeout: 20_000
   }
 
   if (isEvpProxy) {
     options.path = `${evpProxyPrefix}/api/v2/libraries/tests/services/setting`
     options.headers['X-Datadog-EVP-Subdomain'] = 'api'
   } else {
-    const apiKey = process.env.DATADOG_API_KEY || process.env.DD_API_KEY
+    const apiKey = getEnvironmentVariable('DD_API_KEY')
     if (!apiKey) {
       return done(new Error('Request to settings endpoint was not done because Datadog API key is not defined.'))
     }
@@ -69,7 +71,7 @@ function getLibraryConfiguration ({
         env,
         repository_url: repositoryUrl,
         sha,
-        branch
+        branch: branch || tag
       }
     }
   })
@@ -95,7 +97,8 @@ function getLibraryConfiguration ({
               flaky_test_retries_enabled: isFlakyTestRetriesEnabled,
               di_enabled: isDiEnabled,
               known_tests_enabled: isKnownTestsEnabled,
-              test_management: testManagementConfig
+              test_management: testManagementConfig,
+              impacted_tests_enabled: isImpactedTestsEnabled
             }
           }
         } = JSON.parse(res)
@@ -115,16 +118,17 @@ function getLibraryConfiguration ({
           isKnownTestsEnabled,
           isTestManagementEnabled: (testManagementConfig?.enabled ?? false),
           testManagementAttemptToFixRetries:
-            testManagementConfig?.attempt_to_fix_retries
+            testManagementConfig?.attempt_to_fix_retries,
+          isImpactedTestsEnabled
         }
 
         log.debug(() => `Remote settings: ${JSON.stringify(settings)}`)
 
-        if (process.env.DD_CIVISIBILITY_DANGEROUSLY_FORCE_COVERAGE) {
+        if (getEnvironmentVariable('DD_CIVISIBILITY_DANGEROUSLY_FORCE_COVERAGE')) {
           settings.isCodeCoverageEnabled = true
           log.debug(() => 'Dangerously set code coverage to true')
         }
-        if (process.env.DD_CIVISIBILITY_DANGEROUSLY_FORCE_TEST_SKIPPING) {
+        if (getEnvironmentVariable('DD_CIVISIBILITY_DANGEROUSLY_FORCE_TEST_SKIPPING')) {
           settings.isSuitesSkippingEnabled = true
           log.debug(() => 'Dangerously set test skipping to true')
         }

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

@@ -81,6 +81,8 @@ const TELEMETRY_GIT_REQUESTS_SETTINGS = 'git_requests.settings'
 const TELEMETRY_GIT_REQUESTS_SETTINGS_MS = 'git_requests.settings_ms'
 const TELEMETRY_GIT_REQUESTS_SETTINGS_ERRORS = 'git_requests.settings_errors'
 const TELEMETRY_GIT_REQUESTS_SETTINGS_RESPONSE = 'git_requests.settings_response'
+const TELEMETRY_GIT_SHA_MATCH = 'git.commit_sha_match'
+const TELEMETRY_GIT_COMMIT_SHA_DISCREPANCY = 'git.commit_sha_discrepancy'
 const TELEMETRY_ITR_SKIPPABLE_TESTS = 'itr_skippable_tests.request'
 const TELEMETRY_ITR_SKIPPABLE_TESTS_MS = 'itr_skippable_tests.request_ms'
 const TELEMETRY_ITR_SKIPPABLE_TESTS_ERRORS = 'itr_skippable_tests.request_errors'
@@ -144,6 +146,8 @@ module.exports = {
   TELEMETRY_GIT_REQUESTS_SETTINGS_MS,
   TELEMETRY_GIT_REQUESTS_SETTINGS_ERRORS,
   TELEMETRY_GIT_REQUESTS_SETTINGS_RESPONSE,
+  TELEMETRY_GIT_SHA_MATCH,
+  TELEMETRY_GIT_COMMIT_SHA_DISCREPANCY,
   TELEMETRY_ITR_SKIPPABLE_TESTS,
   TELEMETRY_ITR_SKIPPABLE_TESTS_MS,
   TELEMETRY_ITR_SKIPPABLE_TESTS_ERRORS,

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

@@ -1,5 +1,6 @@
 const request = require('../../exporters/common/request')
 const id = require('../../id')
+const { getEnvironmentVariable } = require('../../config-helper')
 
 function getTestManagementTests ({
   url,
@@ -16,7 +17,7 @@ function getTestManagementTests ({
     headers: {
       'Content-Type': 'application/json'
     },
-    timeout: 20000,
+    timeout: 20_000,
     url
   }
 
@@ -28,7 +29,7 @@ function getTestManagementTests ({
     options.path = `${evpProxyPrefix}/api/v2/test/libraries/test-management/tests`
     options.headers['X-Datadog-EVP-Subdomain'] = 'api'
   } else {
-    const apiKey = process.env.DATADOG_API_KEY || process.env.DD_API_KEY
+    const apiKey = getEnvironmentVariable('DD_API_KEY')
     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-helper.js

@@ -0,0 +1,89 @@
+'use strict'
+
+/* eslint-disable eslint-rules/eslint-process-env */
+
+const { deprecate } = require('util')
+const { supportedConfigurations, aliases, deprecations } = require('./supported-configurations.json')
+
+const aliasToCanonical = {}
+for (const canonical of Object.keys(aliases)) {
+  for (const alias of aliases[canonical]) {
+    if (aliasToCanonical[alias]) {
+      throw new Error(`The alias ${alias} is already used for ${aliasToCanonical[alias]}.`)
+    }
+    aliasToCanonical[alias] = canonical
+  }
+}
+
+const deprecationMethods = {}
+for (const deprecation of Object.keys(deprecations)) {
+  deprecationMethods[deprecation] = deprecate(
+    () => {},
+    `The environment variable ${deprecation} is deprecated.` +
+    (aliasToCanonical[deprecation]
+      ? ` Please use ${aliasToCanonical[deprecation]} instead.`
+      : ` ${deprecations[deprecation]}`),
+    `DATADOG_${deprecation}`
+  )
+}
+
+module.exports = {
+  /**
+   * Returns the environment variables that are supported by the tracer
+   * (including all non-Datadog/OTEL specific environment variables)
+   *
+   * @returns {Partial<process.env>} The environment variables
+   */
+  getEnvironmentVariables () {
+    const configs = {}
+    for (const [key, value] of Object.entries(process.env)) {
+      if (key.startsWith('DD_') || key.startsWith('OTEL_') || aliasToCanonical[key]) {
+        if (supportedConfigurations[key]) {
+          configs[key] = value
+        } else if (aliasToCanonical[key] && configs[aliasToCanonical[key]] === undefined) {
+          // The alias should only be used if the actual configuration is not set
+          // In case that more than a single alias exist, use the one defined first in our own order
+          for (const alias of aliases[aliasToCanonical[key]]) {
+            if (process.env[alias] !== undefined) {
+              configs[aliasToCanonical[key]] = value
+              break
+            }
+          }
+        // TODO(BridgeAR) Implement logging. It would have to use a timeout to
+        // lazily log the message after all loading being done otherwise.
+        //   debug(
+        //     `Missing configuration ${env} in supported-configurations file. The environment variable is ignored.`
+        //   )
+        }
+        deprecationMethods[key]?.()
+      } else {
+        configs[key] = value
+      }
+    }
+    return configs
+  },
+
+  /**
+   * Returns the environment variable, if it's supported or a non Datadog
+   * configuration. Otherwise, it throws an error.
+   *
+   * @param {string} name Environment variable name
+   * @returns {string|undefined}
+   * @throws {Error} if the configuration is not supported
+   */
+  getEnvironmentVariable (name) {
+    if ((name.startsWith('DD_') || name.startsWith('OTEL_') || aliasToCanonical[name]) &&
+        !supportedConfigurations[name]) {
+      throw new Error(`Missing ${name} env/configuration in "supported-configurations.json" file.`)
+    }
+    const config = process.env[name]
+    if (config === undefined && aliases[name]) {
+      for (const alias of aliases[name]) {
+        if (process.env[alias] !== undefined) {
+          return process.env[alias]
+        }
+      }
+    }
+    return config
+  }
+}