dd-trace 6.16.0 → 6.18.0

package/packages/dd-trace/src/log/index.js

@@ -8,7 +8,7 @@ const { getValueFromEnvSources } = require('../config/helper')
 // `config/defaults` defers its own `dns` require until after it exports, so this no longer hits
 // the `config/defaults` <-> log parse cycle that motivated the lazy require below.
 const { defaults } = require('../config/defaults')
-const { traceChannel, debugChannel, infoChannel, warnChannel, errorChannel } = require('./channels')
+const { traceChannel, debugChannel, infoChannel, warnChannel, errorChannel, errorRecordChannel } = require('./channels')
 const logWriter = require('./writer')
 const { Log, LogConfig, NoTransmitError } = require('./log')
 
@@ -95,10 +95,25 @@ const log = {
 }
 
 function publishFormatted (ch, formatter, ...args) {
-  if (ch.hasSubscribers) {
-    const log = Log.parse(...args)
-    const { formatted, cause } = getErrorLog(log)
+  const publishRecord = ch === errorChannel && errorRecordChannel.hasSubscribers
+  const publishLog = ch.hasSubscribers
+  if (!publishLog && !publishRecord) return
+
+  let record
+  try {
+    const parsed = Log.parse(...args)
+    if (!publishLog && !parsed.sendViaTelemetry) return
+    record = getErrorLog(parsed)
+  } catch (err) {
+    // Telemetry must not expose parsing failures while the configured logger is disabled.
+    if (!publishLog) return
+    throw err
+  }
+
+  if (publishRecord) errorRecordChannel.publish(record)
 
+  if (publishLog) {
+    const { formatted, cause } = record
     // calling twice ch.publish() because Error cause is only available in Node.js v16.9.0
     // TODO: replace it with Error(message, { cause }) when cause has broad support
     if (formatted) ch.publish(formatter?.(formatted) || formatted)
@@ -109,7 +124,10 @@ function publishFormatted (ch, formatter, ...args) {
 function getErrorLog (err) {
   if (typeof err?.delegate === 'function') {
     const result = err.delegate(...err.args)
-    return Array.isArray(result) ? Log.parse(...result) : Log.parse(result)
+    const resolved = Array.isArray(result) ? Log.parse(...result) : Log.parse(result)
+    resolved.cause ??= err.cause
+    resolved.sendViaTelemetry &&= err.sendViaTelemetry
+    return resolved
   }
   return err
 }

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

@@ -1,7 +1,13 @@
 'use strict'
 
 const { Writable } = require('node:stream')
+const { formatWithOptions } = require('node:util')
 
+const { channel } = require('dc-polyfill')
+
+const { LOG } = require('../../../../ext/formats')
+const { SPAN_TYPE } = require('../../../../ext/tags')
+const { storage } = require('../../../datadog-core')
 const FinalFlushRequestTracker = require('../exporters/common/final-flush-request-tracker')
 const request = require('../exporters/common/request')
 const log = require('../log')
@@ -11,6 +17,13 @@ const MAX_BATCH_BYTES = 5 * 1024 * 1024
 const MAX_BATCH_LOGS = 1000
 const BATCH_FLUSH_INTERVAL = 1000
 const FINAL_FLUSH_TIMEOUT = 60_000
+const CONSOLE_METHOD_TO_STATUS = {
+  error: 'error',
+  warn: 'warn',
+}
+const TEST_OPTIMIZATION_SPAN_TYPES = new Set(['test', 'test_session_end', 'test_suite_end'])
+const consoleConfigureCh = channel('ci:log-submission:console:configure')
+const legacyStorage = storage('legacy')
 
 /**
  * @returns {Error & { code: string }}
@@ -59,12 +72,36 @@ function asTracerConfig (config) {
 /**
  * @param {import('../config/config-base')} config
  * @param {string} source
- * @returns {string}
  */
 function getLogSubmissionPath (config, source) {
   return `/api/v2/logs?${new URLSearchParams({ ddsource: source, service: config.service })}`
 }
 
+/**
+ * @param {object | undefined} store
+ */
+function getTestOptimizationSpan (store) {
+  const activeSpan = store?.span
+  if (activeSpan && TEST_OPTIMIZATION_SPAN_TYPES.has(activeSpan.context().getTag(SPAN_TYPE))) {
+    return activeSpan
+  }
+
+  // Child instrumentation spans replace store.span, so recover the enclosing test from their trace.
+  const traceSpans = activeSpan?.context()._trace?.started
+  if (traceSpans) {
+    let nestedTestSuiteSpan
+    for (const span of traceSpans) {
+      const spanType = span.context().getTag(SPAN_TYPE)
+      if (spanType === 'test') return span
+      if (spanType === 'test_suite_end') nestedTestSuiteSpan = span
+    }
+    if (nestedTestSuiteSpan) return nestedTestSuiteSpan
+  }
+
+  const testSuiteSpan = store?.testSuiteSpan
+  if (testSuiteSpan?.context().getTag(SPAN_TYPE) === 'test_suite_end') return testSuiteSpan
+}
+
 class LogSubmissionPlugin extends Plugin {
   static id = 'log-submission'
 
@@ -79,6 +116,22 @@ class LogSubmissionPlugin extends Plugin {
   #timer
   #beforeExitHandler = () => this.#flushLogs()
   #createWinstonJsonFormat
+  #getConsoleLogHolder = () => {
+    if (!this._enabled ||
+        !this.#logSubmissionUrl ||
+        !this.#config?.isCiVisibility ||
+        !this.#config.DD_AGENTLESS_LOG_SUBMISSION_ENABLED) return
+
+    const store = legacyStorage.getStore()
+    if (store?.noop) return
+    const span = getTestOptimizationSpan(store)
+    if (!span) return
+
+    const logHolder = {}
+    this.tracer.inject(span, LOG, logHolder)
+    return logHolder.dd ? logHolder : undefined
+  }
+
   #winstonStreamClass
   // Winston formats records inside its transports, not at logger.write time, so (unlike Bunyan/Pino)
   // the instrumentation can't publish a post-format line. A Stream transport pipes format.json()
@@ -135,6 +188,20 @@ class LogSubmissionPlugin extends Plugin {
     this.addSub('ci:log-submission:log', (payload) => {
       this.#enqueueLog(payload)
     })
+    this.addSub('ci:log-submission:console', ({ args, logHolder, method }) => {
+      let message
+      try {
+        message = formatWithOptions({}, ...args)
+      } catch (error) {
+        log.error('Could not format console log for automatic submission', error)
+        return
+      }
+
+      this.#enqueueLog({
+        source: 'nodejs',
+        message: { dd: logHolder.dd, message, status: CONSOLE_METHOD_TO_STATUS[method] },
+      })
+    })
     this.addSub('ci:log-submission:flush', ({ onDone } = {}) => {
       if (!onDone) {
         this.#flushLogs()
@@ -149,7 +216,6 @@ class LogSubmissionPlugin extends Plugin {
 
   /**
    * @param {boolean | (Record<string, unknown> & { enabled: boolean })} config
-   * @returns {void}
    */
   configure (config) {
     if (this._enabled) this.#flushLogs()
@@ -160,6 +226,12 @@ class LogSubmissionPlugin extends Plugin {
       ? getLogSubmissionUrl(this.#config)
       : undefined
     super.configure(config)
+    if (this._enabled &&
+        this.#logSubmissionUrl &&
+        this.#config?.isCiVisibility &&
+        this.#config.DD_AGENTLESS_LOG_SUBMISSION_ENABLED) {
+      consoleConfigureCh.publish({ getLogHolder: this.#getConsoleLogHolder })
+    }
 
     const beforeExitHandlers = globalThis[Symbol.for('dd-trace')].beforeExitHandlers
     if (this._enabled) {
@@ -171,7 +243,6 @@ class LogSubmissionPlugin extends Plugin {
 
   /**
    * @param {{ source: string, message: string | Record<string, unknown> }} payload
-   * @returns {void}
    */
   #enqueueLog ({ source, message }) {
     if (!this.#logSubmissionUrl) return
@@ -210,9 +281,6 @@ class LogSubmissionPlugin extends Plugin {
     }
   }
 
-  /**
-   * @returns {void}
-   */
   #flushLogs () {
     clearTimeout(this.#timer)
     this.#timer = undefined

package/packages/dd-trace/src/msgpack/chunk.js

@@ -67,7 +67,6 @@ class MsgpackChunk {
    * buffer at the resulting position.
    *
    * @param {string} value
-   * @returns {number}
    */
   write (value) {
     const length = Buffer.byteLength(value)

package/packages/dd-trace/src/openfeature/agentless_configuration_source.js

@@ -64,9 +64,6 @@ class AgentlessConfigurationSource {
     this.#applyConfiguration = applyConfiguration
   }
 
-  /**
-   * @returns {void}
-   */
   start () {
     if (this.#abortController) return
 
@@ -75,9 +72,6 @@ class AgentlessConfigurationSource {
     this.#poll(abortController)
   }
 
-  /**
-   * @returns {void}
-   */
   stop () {
     this.#abortController?.abort()
     this.#abortController = undefined
@@ -175,7 +169,6 @@ class AgentlessConfigurationSource {
 
   /**
    * @param {PollResponse} response
-   * @returns {void}
    */
   #apply (response) {
     const statusCode = response.statusCode
@@ -218,7 +211,6 @@ class AgentlessConfigurationSource {
    * @param {number | undefined} statusCode
    * @param {unknown} error
    * @param {number} attempts
-   * @returns {void}
    */
   #warnFailure (statusCode, error, attempts) {
     const category = statusCode === 401 || statusCode === 403
@@ -279,7 +271,6 @@ function parseConfiguration (body) {
 
 /**
  * @param {unknown} error
- * @returns {string}
  */
 function errorMessage (error) {
   return error instanceof Error ? error.message : String(error ?? 'request was not sent')
@@ -287,7 +278,6 @@ function errorMessage (error) {
 
 /**
  * @param {number | undefined} status
- * @returns {boolean}
  */
 function isRetryableStatus (status) {
   return status === 408 || status === 429 || (status >= 500 && status <= 599)
@@ -297,7 +287,6 @@ function isRetryableStatus (status) {
  * @param {number} pollIntervalMs
  * @param {number} attempt
  * @param {number} random
- * @returns {number}
  */
 function retryDelay (pollIntervalMs, attempt, random) {
   const base = attempt === 1
@@ -310,7 +299,6 @@ function retryDelay (pollIntervalMs, attempt, random) {
  * @param {number} value
  * @param {number} minimum
  * @param {number} maximum
- * @returns {number}
  */
 function clamp (value, minimum, maximum) {
   return Math.max(minimum, Math.min(maximum, value))

package/packages/dd-trace/src/openfeature/configuration_source.js

@@ -1,5 +1,6 @@
 'use strict'
 
+const { createSiteUrl } = require('../exporters/common/url')
 const log = require('../log')
 
 const DEFAULT_AGENTLESS_PATH = '/api/v2/feature-flagging/config/rules-based/server'
@@ -60,7 +61,9 @@ function endpoint (config, configuredBaseUrl) {
   const configured = configuredBaseUrl?.trim()
 
   if (!configured) {
-    const url = new URL(`https://ufc-server.ff-cdn.${config.site.toLowerCase()}${DEFAULT_AGENTLESS_PATH}`)
+    const url = createSiteUrl(config.site, 'ufc-server.ff-cdn')
+    if (url === undefined) throw new Error('Invalid DD_SITE for Feature Flagging agentless configuration')
+    url.pathname = DEFAULT_AGENTLESS_PATH
     if (config.env) url.searchParams.set('dd_env', config.env)
     return url
   }

package/packages/dd-trace/src/openfeature/encoding.js

@@ -29,7 +29,6 @@ function encodeVarint (value) {
  * 4. Base64 encode the result
  *
  * @param {Set<number>} serialIds - Set of serial IDs to encode
- * @returns {string} Base64-encoded delta-varint string
  */
 function encodeDeltaVarint (serialIds) {
   if (!serialIds || serialIds.size === 0) {
@@ -57,7 +56,6 @@ function encodeDeltaVarint (serialIds) {
  * Hash a targeting key using SHA256.
  *
  * @param {string} targetingKey - The targeting key to hash
- * @returns {string} Lowercase hex digest of the SHA256 hash
  */
 function hashTargetingKey (targetingKey) {
   return crypto.createHash('sha256').update(targetingKey).digest('hex')

package/packages/dd-trace/src/openfeature/eval-metrics-hook.js

@@ -72,7 +72,6 @@ class EvalMetricsHook {
    * @param {{ flagKey: string }} hookContext - Hook context containing the flag key
    * @param {{ variant?: string, reason?: string, errorCode?: string, flagMetadata?: object }} evaluationDetails
    *   - Full evaluation details
-   * @returns {void}
    */
   finally (hookContext, evaluationDetails) {
     if (!this.#enabled) return

package/packages/dd-trace/src/openfeature/flagging_provider.js

@@ -27,12 +27,12 @@ class FlaggingProvider extends DatadogNodeServerProvider {
   constructor (tracer, config) {
     super({
       exposureChannel: channel(EXPOSURE_CHANNEL),
-      initializationTimeoutMs: config.experimental.flaggingProvider.initializationTimeoutMs,
+      initializationTimeoutMs: config.featureFlags.DD_EXPERIMENTAL_FLAGGING_PROVIDER_INITIALIZATION_TIMEOUT_MS,
     })
 
     this.hooks.push(new EvalMetricsHook(config))
 
-    if (config.experimental.flaggingProvider.spanEnrichment?.enabled) {
+    if (config.featureFlags.DD_EXPERIMENTAL_FLAGGING_PROVIDER_SPAN_ENRICHMENT_ENABLED) {
       this.#spanEnrichmentHook = new SpanEnrichmentHook(tracer)
       // @ts-expect-error The upstream constructor always initializes its optional hooks property.
       this.hooks.push(this.#spanEnrichmentHook)
@@ -42,7 +42,7 @@ class FlaggingProvider extends DatadogNodeServerProvider {
     }
 
     log.debug('%s created with timeout: %dms', this.constructor.name,
-      config.experimental.flaggingProvider.initializationTimeoutMs)
+      config.featureFlags.DD_EXPERIMENTAL_FLAGGING_PROVIDER_INITIALIZATION_TIMEOUT_MS)
 
     this.#configurationSource = configurationSource.create(config, this.setConfiguration.bind(this))
     this.#configurationSource?.start()

package/packages/dd-trace/src/openfeature/index.js

@@ -3,17 +3,17 @@
 const { channel } = require('dc-polyfill')
 const log = require('../log')
 const ExposuresWriter = require('./writers/exposures')
-const { setExposureDeliveryStrategy } = require('./writers/util')
+const { setEventDeliveryStrategy } = require('./writers/util')
 
 const exposureSubmitCh = channel('ffe:exposure:submit')
 const flushCh = channel('ffe:writers:flush')
 
 let exposuresWriter = null
+let stopEventDeliveryStrategy
 
 /**
  * @private
  * @param {object | Array<object>} exposureEvents - Exposure events channel subscriber
- * @returns {void}
  */
 function _handleExposureSubmit (exposureEvents) {
   if (!exposuresWriter) return
@@ -23,7 +23,6 @@ function _handleExposureSubmit (exposureEvents) {
 /**
  * Channel subscriber for manually flushing the exposures writer
  * @private
- * @returns {void}
  */
 function _handleFlush () {
   exposuresWriter?.flush()
@@ -32,7 +31,6 @@ function _handleFlush () {
 /**
  * Enables the OpenFeature module and sets up FF&E writer and channel subscribers
  * @param {import('../config')} config - Tracer configuration object
- * @returns {void}
  */
 function enable (config) {
   if (exposuresWriter) {
@@ -45,7 +43,7 @@ function enable (config) {
   exposureSubmitCh.subscribe(_handleExposureSubmit)
   flushCh.subscribe(_handleFlush)
 
-  setExposureDeliveryStrategy(config, (enabled, route) => {
+  stopEventDeliveryStrategy = setEventDeliveryStrategy(config, (enabled, route) => {
     if (exposuresWriter !== writer) return
 
     writer.setEnabled(enabled, route)
@@ -54,11 +52,13 @@ function enable (config) {
 
 /**
  * Disables the OpenFeature module and cleans up resources
- * @returns {void}
  */
 function disable () {
   if (!exposuresWriter) return
 
+  stopEventDeliveryStrategy?.()
+  stopEventDeliveryStrategy = undefined
+
   if (exposureSubmitCh.hasSubscribers) {
     exposureSubmitCh.unsubscribe(_handleExposureSubmit)
   }

package/packages/dd-trace/src/openfeature/span-enrichment-hook.js

@@ -69,7 +69,6 @@ class SpanEnrichmentHook {
    * @param {boolean} [evaluationDetails.flagMetadata.__dd_do_log] - Whether to log subject
    * @param {string} [evaluationDetails.variant] - Variant key if flag was found in UFC
    * @param {boolean|string|number|object} [evaluationDetails.value] - Evaluated value
-   * @returns {void}
    */
   finally (hookContext, evaluationDetails) {
     try {

package/packages/dd-trace/src/openfeature/span-enrichment.js

@@ -30,7 +30,6 @@ class SpanEnrichmentState {
    * Add a serial ID from a flag evaluation.
    *
    * @param {number} serialId - The serial ID to add
-   * @returns {boolean} True if added, false if limit reached
    */
   addSerialId (serialId) {
     if (this._serialIds.size >= MAX_SERIAL_IDS) {
@@ -47,7 +46,6 @@ class SpanEnrichmentState {
    *
    * @param {string} targetingKey - The targeting key (will be hashed)
    * @param {number} serialId - The serial ID associated with this evaluation
-   * @returns {boolean} True if added, false if limit reached
    */
   addSubject (targetingKey, serialId) {
     const hashedKey = hashTargetingKey(targetingKey)
@@ -77,7 +75,6 @@ class SpanEnrichmentState {
    *
    * @param {string} flagKey - The flag key
    * @param {boolean|string|number|object} defaultValue - The default value used
-   * @returns {boolean} True if added, false if limit reached
    */
   addDefault (flagKey, defaultValue) {
     if (this._defaults.has(flagKey)) {
@@ -106,7 +103,6 @@ class SpanEnrichmentState {
    * Note: _subjects is not checked because addSubject() is never called without first
    * calling addSerialId(), so _subjects having data necessitates _serialIds having data.
    *
-   * @returns {boolean} True if there is data to add
    */
   hasData () {
     return this._serialIds.size > 0 || this._defaults.size > 0