chore: add config types across the board

BridgeAR · BridgeAR · commit 120cbbb94eec · 2026-03-18T23:17:58.000+01:00
diff --git a/packages/dd-trace/src/agent/url.js b/packages/dd-trace/src/agent/url.js
@@ -12,7 +12,7 @@ module.exports = { getAgentUrl }
 
 /**
  * Gets the agent URL from config, constructing it from hostname/port if needed
- * @param {ReturnType<import('../config')>} config - Tracer configuration object
+ * @param {import('../config/config-base')} config - Tracer configuration object
  * @returns {URL} The agent URL
  */
 function getAgentUrl (config) {
diff --git a/packages/dd-trace/src/aiguard/sdk.js b/packages/dd-trace/src/aiguard/sdk.js
@@ -57,6 +57,10 @@ class AIGuard extends NoopAIGuard {
   #maxContentSize
   #meta
 
+  /**
+   * @param {import('../tracer')} tracer - Tracer instance
+   * @param {import('../config/config-base')} config - Tracer configuration
+   */
   constructor (tracer, config) {
     super()
 
diff --git a/packages/dd-trace/src/appsec/blocking.js b/packages/dd-trace/src/appsec/blocking.js
@@ -164,6 +164,9 @@ function getBlockingAction (actions) {
   return actions?.redirect_request || actions?.block_request
 }
 
+/**
+ * @param {import('../config/config-base')} config - Tracer configuration
+ */
 function setTemplates (config) {
   templateHtml = config.appsec.blockedTemplateHtml || blockedTemplates.html
 
diff --git a/packages/dd-trace/src/appsec/sdk/index.js b/packages/dd-trace/src/appsec/sdk/index.js
@@ -26,6 +26,10 @@ class EventTrackingV2 {
 }
 
 class AppsecSdk {
+  /**
+   * @param {import('../../tracer')} tracer - Tracer instance
+   * @param {import('../../config/config-base')} config - Tracer configuration
+   */
   constructor (tracer, config) {
     this._tracer = tracer
     if (config) {
diff --git a/packages/dd-trace/src/ci-visibility/dynamic-instrumentation/index.js b/packages/dd-trace/src/ci-visibility/dynamic-instrumentation/index.js
@@ -11,6 +11,9 @@ const probeIdToResolveBreakpointSet = new Map()
 const probeIdToResolveBreakpointRemove = new Map()
 
 class TestVisDynamicInstrumentation {
+  /**
+   * @param {import('../../config/config-base')} config - Tracer configuration
+   */
   constructor (config) {
     this._config = config
     this.worker = null
@@ -150,6 +153,9 @@ class TestVisDynamicInstrumentation {
 
 let dynamicInstrumentation
 
+/**
+ * @param {import('../../config/config-base')} config - Tracer configuration
+ */
 module.exports = function createAndGetTestVisDynamicInstrumentation (config) {
   if (dynamicInstrumentation) {
     return dynamicInstrumentation
diff --git a/packages/dd-trace/src/ci-visibility/test-api-manual/test-api-manual-plugin.js b/packages/dd-trace/src/ci-visibility/test-api-manual/test-api-manual-plugin.js
@@ -54,6 +54,10 @@ class TestApiManualPlugin extends CiPlugin {
     })
   }
 
+  /**
+   * @param {import('../../config/config-base')} config - Tracer configuration
+   * @param {boolean} shouldGetEnvironmentData - Whether to get environment data
+   */
   configure (config, shouldGetEnvironmentData) {
     this._config = config
     super.configure(config, shouldGetEnvironmentData)
diff --git a/packages/dd-trace/src/config/config-types.d.ts b/packages/dd-trace/src/config/config-types.d.ts
@@ -1,6 +1,6 @@
 import type { GeneratedConfig } from './generated-config-types'
 
-type PayloadTaggingRules = ReturnType<typeof import('../payload-tagging/config').appendRules>
+type PayloadTaggingRules = ReturnType<typeof import('../payload-tagging/config').appendRules> | []
 
 export interface ConfigProperties extends GeneratedConfig {
   cloudPayloadTagging: GeneratedConfig['cloudPayloadTagging'] & {
@@ -77,3 +77,4 @@ type ConfigPathValueFor<T, TPath extends string> =
 export type ConfigKey = KnownStringKeys<ConfigProperties>
 export type ConfigPath = ConfigPathFor<ConfigProperties>
 export type ConfigPathValue<TPath extends ConfigPath> = ConfigPathValueFor<ConfigProperties, TPath>
+export type ConfigDefaults = Partial<{ [TPath in ConfigPath]: ConfigPathValue<TPath> }>
diff --git a/packages/dd-trace/src/config/defaults.js b/packages/dd-trace/src/config/defaults.js
@@ -466,6 +466,7 @@ for (const [fullPropertyName, alias] of fallbackConfigurations) {
 }
 
 // Defaults required by JS config merge/applyCalculated that are not represented in supported-configurations.
+/** @type {import('./config-types').ConfigDefaults} */
 const calculatedConfigurations = {
   startupLogs: DD_MAJOR >= 6,
   'cloudPayloadTagging.rules': [],
@@ -487,20 +488,20 @@ for (const [name, value] of Object.entries(calculatedConfigurations)) {
   })
 }
 
-/** @type {Record<string, unknown>} */
+/**
+ * Default values indexed by flattened config path.
+ * Only paths with explicit defaults are present.
+ *
+ * @type {import('./config-types').ConfigDefaults}
+ */
 const defaults = {
-  ...metadataDefaults,
+  .../** @type {import('./config-types').ConfigDefaults} */ (metadataDefaults),
   ...calculatedConfigurations,
 }
 
 module.exports = {
   configurationsTable,
-  /**
-   * Returns the default values for the configuration names
-   * (including all non-Datadog/OTEL specific configuration names).
-   *
-   * @returns {Record<string, unknown>} The default values
-   */
+
   defaults,
 
   // Defines one way aliases
diff --git a/packages/dd-trace/src/config/generated-config-types.d.ts b/packages/dd-trace/src/config/generated-config-types.d.ts
@@ -282,6 +282,7 @@ export interface GeneratedConfig {
   DD_TRACE_LANGCHAIN_ENABLED: boolean;
   DD_TRACE_LANGCHAIN_GOOGLE_GENAI_ENABLED: boolean;
   DD_TRACE_LANGCHAIN_OPENAI_ENABLED: boolean;
+  DD_TRACE_LANGGRAPH_ENABLED: boolean;
   DD_TRACE_LDAPJS_ENABLED: boolean;
   DD_TRACE_LDAPJS_PROMISE_ENABLED: boolean;
   DD_TRACE_LIMITD_CLIENT_ENABLED: boolean;
diff --git a/packages/dd-trace/src/crashtracking/crashtracker.js b/packages/dd-trace/src/crashtracking/crashtracker.js
@@ -23,6 +23,9 @@ class Crashtracker {
     }
   }
 
+  /**
+   * @param {import('../config/config-base')} config - Tracer configuration
+   */
   start (config) {
     if (this.#started) return this.configure(config)
 
@@ -49,6 +52,9 @@ class Crashtracker {
   }
 
   // TODO: Send only configured values when defaults are fixed.
+  /**
+   * @param {import('../config/config-base')} config - Tracer configuration
+   */
   #getConfig (config) {
     const url = getAgentUrl(config)
 
diff --git a/packages/dd-trace/src/debugger/index.js b/packages/dd-trace/src/debugger/index.js
@@ -147,7 +147,7 @@ function start (config, rcInstance) {
  * Sends the new configuration to the worker thread via the config channel.
  * Does nothing if the worker is not started.
  *
- * @param {Config} config - The updated tracer configuration object
+ * @param {import('../config/config-base')} config - The updated tracer configuration object
  */
 function configure (config) {
   if (configChannel === null) return
diff --git a/packages/dd-trace/src/dogstatsd.js b/packages/dd-trace/src/dogstatsd.js
@@ -165,6 +165,9 @@ class DogStatsDClient {
     return socket
   }
 
+  /**
+   * @param {import('./config/config-base')} config - Tracer configuration
+   */
   static generateClientConfig (config) {
     const tags = []
 
diff --git a/packages/dd-trace/src/heap_snapshots.js b/packages/dd-trace/src/heap_snapshots.js
@@ -45,6 +45,9 @@ function getName (destination) {
 }
 
 module.exports = {
+  /**
+   * @param {import('./config/config-base')} config - Tracer configuration
+   */
   async start (config) {
     const destination = config.heapSnapshot.destination
 
diff --git a/packages/dd-trace/src/llmobs/sdk.js b/packages/dd-trace/src/llmobs/sdk.js
@@ -29,6 +29,11 @@ class LLMObs extends NoopLLMObs {
    */
   #hasUserSpanProcessor = false
 
+  /**
+   * @param {import('../tracer')} tracer - Tracer instance
+   * @param {import('./index')} llmobsModule - LLMObs module instance
+   * @param {import('../config/config-base')} config - Tracer configuration
+   */
   constructor (tracer, llmobsModule, config) {
     super(tracer)
 
@@ -57,7 +62,6 @@ class LLMObs extends NoopLLMObs {
     }
 
     // TODO: These configs should be passed through directly at construction time instead.
-    this._config.llmobs ??= {}
     this._config.llmobs.enabled = true
     this._config.llmobs.mlApp = options.mlApp
     this._config.llmobs.agentlessEnabled = options.agentlessEnabled
diff --git a/packages/dd-trace/src/opentelemetry/logs/index.js b/packages/dd-trace/src/opentelemetry/logs/index.js
@@ -33,7 +33,7 @@ const OtlpHttpLogExporter = require('./otlp_http_log_exporter')
 
 /**
  * Initializes OpenTelemetry Logs support
- * @param {Config} config - Tracer configuration instance
+ * @param {import('../../config/config-base')} config - Tracer configuration instance
  */
 function initializeOpenTelemetryLogs (config) {
   // Build resource attributes
diff --git a/packages/dd-trace/src/opentelemetry/metrics/index.js b/packages/dd-trace/src/opentelemetry/metrics/index.js
@@ -35,7 +35,7 @@ const OtlpHttpMetricExporter = require('./otlp_http_metric_exporter')
 
 /**
  * Initializes OpenTelemetry Metrics support
- * @param {Config} config - Tracer configuration instance
+ * @param {import('../../config/config-base')} config - Tracer configuration instance
  */
 function initializeOpenTelemetryMetrics (config) {
   const resourceAttributes = {
diff --git a/packages/dd-trace/src/opentelemetry/otlp/otlp_http_exporter_base.js b/packages/dd-trace/src/opentelemetry/otlp/otlp_http_exporter_base.js
@@ -120,7 +120,6 @@ class OtlpHttpExporterBase {
    * @param {string} [headersString=''] - Comma-separated key=value pairs
    * @returns {Record<string, string>} Parsed headers object
    */
-  // TODO: Consider moving this to a transformer or type in supported-configurations.json
   #parseAdditionalHeaders (headersString = '') {
     const headers = {}
     let key = ''
diff --git a/packages/dd-trace/src/plugin_manager.js b/packages/dd-trace/src/plugin_manager.js
@@ -64,7 +64,7 @@ function getEnabled (Plugin) {
 module.exports = class PluginManager {
   constructor (tracer) {
     this._tracer = tracer
-    this._tracerConfig = null
+    this._tracerConfig = /** @type {import('./config/config-base')} */ (null)
     this._pluginsByName = {}
     this._configsByName = {}
 
@@ -118,8 +118,11 @@ module.exports = class PluginManager {
     this.loadPlugin(name)
   }
 
-  // like instrumenter.enable()
-  configure (config = {}) {
+  /**
+   * Like instrumenter.enable()
+   * @param {import('./config/config-base')} config - Tracer configuration
+   */
+  configure (config) {
     this._tracerConfig = config
     this._tracer._nomenclature.configure(config)
 
diff --git a/packages/dd-trace/src/plugins/ci_plugin.js b/packages/dd-trace/src/plugins/ci_plugin.js
@@ -469,6 +469,10 @@ module.exports = class CiPlugin extends Plugin {
     return getSessionRequestErrorTags(this.testSessionSpan)
   }
 
+  /**
+   * @param {import('../config/config-base')} config - Tracer configuration
+   * @param {boolean} shouldGetEnvironmentData - Whether to get environment data
+   */
   configure (config, shouldGetEnvironmentData = true) {
     super.configure(config)
 
diff --git a/packages/dd-trace/src/plugins/plugin.js b/packages/dd-trace/src/plugins/plugin.js
@@ -163,9 +163,10 @@ module.exports = class Plugin {
   /**
    * Enable or disable the plugin and (re)apply its configuration.
    *
-   * @param {boolean|object} config Either a boolean to enable/disable or a configuration object
-   *                                containing at least `{ enabled: boolean }`.
-   * @returns {void}
+   * TODO: Remove the overloading with `enabled` and use the config object directly.
+   *
+   * @param {boolean|import('../config/config-base')} config Either a boolean to enable/disable
+   * or a configuration object containing at least `{ enabled: boolean }`.
    */
   configure (config) {
     if (typeof config === 'boolean') {
diff --git a/packages/dd-trace/src/process-tags/index.js b/packages/dd-trace/src/process-tags/index.js
@@ -72,6 +72,9 @@ function buildProcessTags (config) {
 
 // Singleton with constant defaults so pre-init reads don't blow up
 const processTags = module.exports = {
+  /**
+   * @param {import('../config/config-base')} config
+   */
   initialize (config) {
     // check if one of the properties added during build exist and if so return
     if (processTags.tags) return
diff --git a/packages/dd-trace/src/profiler.js b/packages/dd-trace/src/profiler.js
@@ -5,13 +5,16 @@ const { profiler } = require('./profiling')
 globalThis[Symbol.for('dd-trace')].beforeExitHandlers.add(() => { profiler.stop() })
 
 module.exports = {
-  start: config => {
+  /**
+   * @param {import('./config/config-base')} config - Tracer configuration
+   */
+  start (config) {
     // Forward the full tracer config to the profiling layer.
     // Profiling code is responsible for deriving the specific options it needs.
     return profiler.start(config)
   },
 
-  stop: () => {
+  stop () {
     profiler.stop()
   },
 }
diff --git a/packages/dd-trace/src/profiling/profiler.js b/packages/dd-trace/src/profiling/profiler.js
@@ -64,6 +64,9 @@ 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 = {
@@ -94,6 +97,9 @@ class Profiler extends EventEmitter {
     logError(this.#logger, err)
   }
 
+  /**
+   * @param {import('../config/config-base')} options - Tracer configuration
+   */
   async _start (options) {
     if (this.enabled) return true
 
diff --git a/packages/dd-trace/src/profiling/ssi-heuristics.js b/packages/dd-trace/src/profiling/ssi-heuristics.js
@@ -1,6 +1,6 @@
 'use strict'
 
-const dc = require('dc-polyfill')
+const dc = /** @type {typeof import('diagnostics_channel')} */ (require('dc-polyfill'))
 const log = require('../log')
 
 // If the process lives for at least 30 seconds, it's considered long-lived
@@ -10,6 +10,9 @@ const DEFAULT_LONG_LIVED_THRESHOLD = 30_000
  * This class embodies the SSI profiler-triggering heuristics under SSI.
  */
 class SSIHeuristics {
+  /**
+   * @param {import('../config/config-base')} config - Tracer configuration
+   */
   constructor (config) {
     const longLivedThreshold = config.profiling.longLivedThreshold || DEFAULT_LONG_LIVED_THRESHOLD
     if (typeof longLivedThreshold !== 'number' || longLivedThreshold <= 0) {
diff --git a/packages/dd-trace/src/propagation-hash/index.js b/packages/dd-trace/src/propagation-hash/index.js
@@ -17,11 +17,12 @@ class PropagationHashManager {
   _cachedHash = null
   _cachedHashString = null
   _cachedHashBase64 = null
+  /** @type {import('../config/config-base') | null} */
   _config = null
 
   /**
    * Configure the propagation hash manager with tracer config
-   * @param {object} config - Tracer configuration
+   * @param {import('../config/config-base')} config - Tracer configuration
    */
   configure (config) {
     this._config = config
diff --git a/packages/dd-trace/src/proxy.js b/packages/dd-trace/src/proxy.js
@@ -27,9 +27,12 @@ class LazyModule {
     this.provider = provider
   }
 
-  enable (...args) {
+  /**
+   * @param {import('./config/config-base')} config - Tracer configuration
+   */
+  enable (config, ...args) {
     this.module = this.provider()
-    this.module.enable(...args)
+    this.module.enable(config, ...args)
   }
 
   disable () {
@@ -244,6 +247,9 @@ class Tracer extends NoopProxy {
     return this
   }
 
+  /**
+   * @param {import('./config/config-base')} config - Tracer configuration
+   */
   _startProfiler (config) {
     // do not stop tracer initialization if the profiler fails to be imported
     try {
@@ -256,6 +262,9 @@ class Tracer extends NoopProxy {
     }
   }
 
+  /**
+   * @param {import('./config/config-base')} config - Tracer configuration
+   */
   #updateTracing (config) {
     if (config.tracing !== false) {
       if (config.appsec.enabled) {
diff --git a/packages/dd-trace/src/remote_config/index.js b/packages/dd-trace/src/remote_config/index.js
@@ -25,6 +25,9 @@ class RemoteConfig {
   #products = new Set()
   #batchHandlers = new Map()
 
+  /**
+   * @param {import('../config/config-base')} config - Tracer configuration
+   */
   constructor (config) {
     const pollInterval = Math.floor(config.remoteConfig.pollInterval * 1000)
 
diff --git a/packages/dd-trace/src/runtime_metrics/index.js b/packages/dd-trace/src/runtime_metrics/index.js
diff --git a/packages/dd-trace/src/runtime_metrics/runtime_metrics.js b/packages/dd-trace/src/runtime_metrics/runtime_metrics.js
diff --git a/packages/dd-trace/src/standalone/index.js b/packages/dd-trace/src/standalone/index.js

Original file line number	Diff line number	Diff line change
`@@ -164,6 +164,9 @@ function getBlockingAction (actions) {`
`164`	`164`	`return actions?.redirect_request \|\| actions?.block_request`
`165`	`165`	`}`
`166`	`166`
	`167`	`+/**`
	`168`	`+ * @param {import('../config/config-base')} config - Tracer configuration`
	`169`	`+ */`
`167`	`170`	`function setTemplates (config) {`
`168`	`171`	`templateHtml = config.appsec.blockedTemplateHtml \|\| blockedTemplates.html`
`169`	`172`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,9 @@ class Crashtracker {`
`23`	`23`	`}`
`24`	`24`	`}`
`25`	`25`
	`26`	`+ /**`
	`27`	`+ * @param {import('../config/config-base')} config - Tracer configuration`
	`28`	`+ */`
`26`	`29`	`start (config) {`
`27`	`30`	`if (this.#started) return this.configure(config)`
`28`	`31`
`@@ -49,6 +52,9 @@ class Crashtracker {`
`49`	`52`	`}`
`50`	`53`
`51`	`54`	`// TODO: Send only configured values when defaults are fixed.`
	`55`	`+ /**`
	`56`	`+ * @param {import('../config/config-base')} config - Tracer configuration`
	`57`	`+ */`
`52`	`58`	`#getConfig (config) {`
`53`	`59`	`const url = getAgentUrl(config)`
`54`	`60`