feat: add class ConfigEnvSources to merge stable config and environment variables (#6982)

This makes sure most environment variables will be reading from stable config.

In addition, much code is cleaned up, types are added, and small improvements
were added.

---------

Co-authored-by: Ruben Bridgewater <ruben.bridgewater@datadoghq.com>

Author: 2 people

ci/init.js

@@ -4,7 +4,7 @@
 const tracer = require('../packages/dd-trace')
 const { isTrue, isFalse } = require('../packages/dd-trace/src/util')
 const log = require('../packages/dd-trace/src/log')
-const { getEnvironmentVariable } = require('../packages/dd-trace/src/config/helper')
+const { getEnvironmentVariable, getValueFromEnvSources } = require('../packages/dd-trace/src/config/helper')
 
 const PACKAGE_MANAGERS = ['npm', 'yarn', 'pnpm']
 const DEFAULT_FLUSH_INTERVAL = 5000
@@ -27,9 +27,9 @@ function detectTestWorkerType () {
   if (getEnvironmentVariable('JEST_WORKER_ID')) return 'jest'
   if (getEnvironmentVariable('CUCUMBER_WORKER_ID')) return 'cucumber'
   if (getEnvironmentVariable('MOCHA_WORKER_ID')) return 'mocha'
-  if (getEnvironmentVariable('DD_PLAYWRIGHT_WORKER')) return 'playwright'
+  if (getValueFromEnvSources('DD_PLAYWRIGHT_WORKER')) return 'playwright'
   if (getEnvironmentVariable('TINYPOOL_WORKER_ID')) return 'vitest'
-  if (getEnvironmentVariable('DD_VITEST_WORKER')) return 'vitest'
+  if (getValueFromEnvSources('DD_VITEST_WORKER')) return 'vitest'
   return null
 }
 
@@ -43,8 +43,8 @@ const baseOptions = {
   flushInterval: isJestWorker ? JEST_FLUSH_INTERVAL : DEFAULT_FLUSH_INTERVAL
 }
 
-let shouldInit = !isFalse(getEnvironmentVariable('DD_CIVISIBILITY_ENABLED'))
-const isAgentlessEnabled = isTrue(getEnvironmentVariable('DD_CIVISIBILITY_AGENTLESS_ENABLED'))
+let shouldInit = !isFalse(getValueFromEnvSources('DD_CIVISIBILITY_ENABLED'))
+const isAgentlessEnabled = isTrue(getValueFromEnvSources('DD_CIVISIBILITY_AGENTLESS_ENABLED'))
 
 if (!isTestWorker && isPackageManager()) {
   log.debug('dd-trace is not initialized in a package manager.')
@@ -58,7 +58,7 @@ if (isTestWorker) {
   }
 } else {
   if (isAgentlessEnabled) {
-    if (getEnvironmentVariable('DD_API_KEY')) {
+    if (getValueFromEnvSources('DD_API_KEY')) {
       baseOptions.experimental = {
         exporter: 'datadog'
       }

integration-tests/code-origin/typescript.js

@@ -1,6 +1,6 @@
 require('dd-trace/init')
 
-// @ts-ignore - fastify will be available at runtime
+// @ts-expect-error - fastify will be available at runtime
 import Fastify from 'fastify'
 
 const app = Fastify({

integration-tests/code-origin/typescript.ts

@@ -1,5 +1,4 @@
 // Playwright typescript config file for integration tests
-// @ts-ignore
 import { devices } from '@playwright/test'
 
 export default {

integration-tests/playwright.config.ts

@@ -7,18 +7,14 @@ const requirePackageJson = require('../../../dd-trace/src/require-package-json')
 const log = require('../../../dd-trace/src/log')
 const telemetry = require('../../../dd-trace/src/guardrails/telemetry')
 const { isInServerlessEnvironment } = require('../../../dd-trace/src/serverless')
-const { getEnvironmentVariables } = require('../../../dd-trace/src/config/helper')
+const { getValueFromEnvSources } = require('../../../dd-trace/src/config/helper')
 const checkRequireCache = require('./check-require-cache')
 const Hook = require('./hook')
 const { isRelativeRequire } = require('./shared-utils')
 const rewriter = require('./rewriter')
 
-const envs = getEnvironmentVariables()
-
-const {
-  DD_TRACE_DISABLED_INSTRUMENTATIONS = '',
-  DD_TRACE_DEBUG = ''
-} = envs
+const DD_TRACE_DISABLED_INSTRUMENTATIONS = getValueFromEnvSources('DD_TRACE_DISABLED_INSTRUMENTATIONS') || ''
+const DD_TRACE_DEBUG = getValueFromEnvSources('DD_TRACE_DEBUG') || ''
 
 const hooks = require('./hooks')
 const instrumentations = require('./instrumentations')

packages/datadog-instrumentations/src/helpers/register.js

@@ -2,12 +2,12 @@
 
 const shimmer = require('../../datadog-shimmer')
 const tracer = require('../../dd-trace')
-const { getEnvironmentVariable } = require('../../dd-trace/src/config/helper')
+const { getValueFromEnvSources } = require('../../dd-trace/src/config/helper')
 const { addHook } = require('./helpers/instrument')
 
-const otelSdkEnabled = getEnvironmentVariable('DD_TRACE_OTEL_ENABLED') ||
-getEnvironmentVariable('OTEL_SDK_DISABLED')
-  ? !getEnvironmentVariable('OTEL_SDK_DISABLED')
+const otelSdkEnabled = getValueFromEnvSources('DD_TRACE_OTEL_ENABLED') ||
+getValueFromEnvSources('OTEL_SDK_DISABLED')
+  ? !getValueFromEnvSources('OTEL_SDK_DISABLED')
   : undefined
 
 if (otelSdkEnabled) {

packages/datadog-instrumentations/src/otel-sdk-trace.js

@@ -11,7 +11,7 @@ const {
 } = require('../../dd-trace/src/plugins/util/test')
 const log = require('../../dd-trace/src/log')
 const {
-  getEnvironmentVariable
+  getValueFromEnvSources
 } = require('../../dd-trace/src/config/helper')
 const { DD_MAJOR } = require('../../../version')
 const { addHook, channel } = require('./helpers/instrument')
@@ -41,7 +41,7 @@ const testSuiteToTestStatuses = new Map()
 const testSuiteToErrors = new Map()
 const testsToTestStatuses = new Map()
 
-const RUM_FLUSH_WAIT_TIME = Number(getEnvironmentVariable('DD_CIVISIBILITY_RUM_FLUSH_WAIT_MILLIS')) || 1000
+const RUM_FLUSH_WAIT_TIME = Number(getValueFromEnvSources('DD_CIVISIBILITY_RUM_FLUSH_WAIT_MILLIS')) || 1000
 
 let applyRepeatEachIndex = null
 

packages/datadog-instrumentations/src/playwright.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const shimmer = require('../../datadog-shimmer')
-const { getEnvironmentVariable } = require('../../dd-trace/src/config/helper')
+const { getValueFromEnvSources } = require('../../dd-trace/src/config/helper')
 const { addHook, channel } = require('./helpers/instrument')
 
 const ciSeleniumDriverGetStartCh = channel('ci:selenium:driver:get')
@@ -17,7 +17,7 @@ if (window.DD_RUM && window.DD_RUM.stopSession) {
 const IS_RUM_ACTIVE_SCRIPT = 'return !!window.DD_RUM'
 
 const DD_CIVISIBILITY_RUM_FLUSH_WAIT_MILLIS =
-Number(getEnvironmentVariable('DD_CIVISIBILITY_RUM_FLUSH_WAIT_MILLIS')) || 500
+Number(getValueFromEnvSources('DD_CIVISIBILITY_RUM_FLUSH_WAIT_MILLIS')) || 500
 const DD_CIVISIBILITY_TEST_EXECUTION_ID_COOKIE_NAME = 'datadog-ci-visibility-test-execution-id'
 
 // TODO: can we increase the supported version range?

packages/datadog-instrumentations/src/selenium.js

@@ -5,7 +5,7 @@ const ClientPlugin = require('../../dd-trace/src/plugins/client')
 const { storage } = require('../../datadog-core')
 const { isTrue } = require('../../dd-trace/src/util')
 const { tagsFromRequest, tagsFromResponse } = require('../../dd-trace/src/payload-tagging')
-const { getEnvironmentVariable } = require('../../dd-trace/src/config/helper')
+const { getValueFromEnvSources } = require('../../dd-trace/src/config/helper')
 
 class BaseAwsSdkPlugin extends ClientPlugin {
   static id = 'aws'
@@ -190,7 +190,7 @@ class BaseAwsSdkPlugin extends ClientPlugin {
 
   isEnabled (request) {
     const serviceId = this.serviceIdentifier.toUpperCase()
-    const envVarValue = getEnvironmentVariable(`DD_TRACE_AWS_SDK_${serviceId}_ENABLED`)
+    const envVarValue = getValueFromEnvSources(`DD_TRACE_AWS_SDK_${serviceId}_ENABLED`)
     return envVarValue ? isTrue(envVarValue) : true
   }
 
@@ -273,9 +273,9 @@ function normalizeConfig (config, serviceIdentifier) {
   const serviceId = serviceIdentifier.toUpperCase()
   const batchPropagationEnabled = isTrue(
     specificConfig.batchPropagationEnabled ??
-    getEnvironmentVariable(`DD_TRACE_AWS_SDK_${serviceId}_BATCH_PROPAGATION_ENABLED`) ??
+    getValueFromEnvSources(`DD_TRACE_AWS_SDK_${serviceId}_BATCH_PROPAGATION_ENABLED`) ??
     config.batchPropagationEnabled ??
-    getEnvironmentVariable('DD_TRACE_AWS_SDK_BATCH_PROPAGATION_ENABLED')
+    getValueFromEnvSources('DD_TRACE_AWS_SDK_BATCH_PROPAGATION_ENABLED')
   )
 
   // Merge the specific config back into the main config

packages/datadog-plugin-aws-sdk/src/base.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const { getEnvironmentVariable } = require('../../dd-trace/src/config/helper')
+const { getValueFromEnvSources } = require('../../dd-trace/src/config/helper')
 const ProducerPlugin = require('../../dd-trace/src/plugins/producer')
 
 const spanContexts = new WeakMap()
@@ -89,7 +89,7 @@ function injectTraceContext (tracer, span, event) {
 }
 
 function batchLinksAreEnabled () {
-  const eh = getEnvironmentVariable('DD_TRACE_AZURE_EVENTHUBS_BATCH_LINKS_ENABLED')
+  const eh = getValueFromEnvSources('DD_TRACE_AZURE_EVENTHUBS_BATCH_LINKS_ENABLED')
   return eh !== 'false'
 }