dd-trace 6.15.0 → 6.17.0

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/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/index.js

@@ -13,7 +13,6 @@ let exposuresWriter = null
 /**
  * @private
  * @param {object | Array<object>} exposureEvents - Exposure events channel subscriber
- * @returns {void}
  */
 function _handleExposureSubmit (exposureEvents) {
   if (!exposuresWriter) return
@@ -23,7 +22,6 @@ function _handleExposureSubmit (exposureEvents) {
 /**
  * Channel subscriber for manually flushing the exposures writer
  * @private
- * @returns {void}
  */
 function _handleFlush () {
   exposuresWriter?.flush()
@@ -32,7 +30,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) {
@@ -54,7 +51,6 @@ function enable (config) {
 
 /**
  * Disables the OpenFeature module and cleans up resources
- * @returns {void}
  */
 function disable () {
   if (!exposuresWriter) return

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

package/packages/dd-trace/src/openfeature/writers/base.js

@@ -37,7 +37,6 @@ const log = require('../../log')
  *
  * @param {Error | null} error - Request error
  * @param {number | undefined} statusCode - HTTP response status
- * @returns {boolean} Whether direct retry is safe
  */
 function isDefinitiveRejection (error, statusCode) {
   return error?.code === 'EAI_AGAIN' || error?.code === 'ECONNREFUSED' ||
@@ -49,7 +48,6 @@ function isDefinitiveRejection (error, statusCode) {
  * Tests whether a local route can have accepted an event batch before failing.
  *
  * @param {Error | null} error - Request error
- * @returns {boolean} Whether the delivery result is ambiguous
  */
 function isAmbiguousNetworkFailure (error) {
   return error?.code === 'ECONNRESET' || error?.code === 'EPIPE' || error?.code === 'ETIMEDOUT'
@@ -189,7 +187,6 @@ class BaseFFEWriter {
   /**
    * @private
    * @param {Array<object>} payload - Payload to encode
-   * @returns {string} JSON-stringified payload
    */
   _encode (payload) {
     return JSON.stringify(payload)
@@ -200,7 +197,6 @@ class BaseFFEWriter {
    *
    * @param {WriterRoute} route - Active route
    * @param {WriterRoute} [fallbackRoute] - Direct fallback route
-   * @returns {void}
    */
   _setRoutes (route, fallbackRoute) {
     this.#activateRoute(this.#createRoute(route))
@@ -251,7 +247,6 @@ class BaseFFEWriter {
    * Makes a route active for future event batches.
    *
    * @param {ActiveWriterRoute} route - Route state
-   * @returns {void}
    */
   #activateRoute (route) {
     this._baseUrl = route.url
@@ -266,7 +261,6 @@ class BaseFFEWriter {
    * @param {number} eventCount - Event count
    * @param {ActiveWriterRoute} route - Selected route
    * @param {ActiveWriterRoute} [fallbackRoute] - Direct fallback route
-   * @returns {void}
    */
   #sendRequest (payload, eventCount, route, fallbackRoute) {
     request(payload, route.requestOptions, (error, response, statusCode) => {

package/packages/dd-trace/src/openfeature/writers/exposures.js

@@ -114,7 +114,6 @@ class ExposuresWriter extends BaseFFEWriter {
   /**
    * @param {boolean} enabled - Whether to enable the writer
    * @param {ExposureRoute} [route] - Selected EVP route
-   * @returns {void}
    */
   setEnabled (enabled, route) {
     if (route) {
@@ -134,7 +133,6 @@ class ExposuresWriter extends BaseFFEWriter {
    * Applies caller-supplied route data without performing discovery.
    *
    * @param {ExposureRoute} route - Selected EVP route
-   * @returns {void}
    */
   #setRoute (route) {
     const fallbackRoute = route.fallback && {
@@ -180,9 +178,6 @@ class ExposuresWriter extends BaseFFEWriter {
     }
   }
 
-  /**
-   * @returns {number} Cumulative number of exposure events dropped due to buffer overflow.
-   */
   get droppedEventCount () {
     return this._droppedEvents
   }

package/packages/dd-trace/src/openfeature/writers/util.js

@@ -15,7 +15,6 @@ let missingRouteWarningLogged = false
 /**
  * Logs the unavailable exposure-delivery warning once.
  *
- * @returns {void}
  */
 function warnExposureDeliveryUnavailable () {
   if (missingRouteWarningLogged) return
@@ -31,7 +30,6 @@ function warnExposureDeliveryUnavailable () {
  *
  * @param {import('../../config')} config - Tracer configuration object
  * @param {Function} setWriterEnabledValue - Callback to set the writer enabled state
- * @returns {void}
  */
 function setAgentStrategy (config, setWriterEnabledValue) {
   discoverEVPProxy(config.url, {
@@ -61,7 +59,6 @@ function setAgentStrategy (config, setWriterEnabledValue) {
  *
  * @param {import('../../config')} config - Tracer configuration object
  * @param {Function} setWriterEnabledValue - Callback to set the writer enabled state
- * @returns {void}
  */
 function setAgentlessStrategy (config, setWriterEnabledValue) {
   const directRoute = createDirectEVPRoute(config, EVP_EVENT_PLATFORM_SUBDOMAIN)
@@ -105,7 +102,6 @@ function setAgentlessStrategy (config, setWriterEnabledValue) {
  *
  * @param {import('../../config')} config - Tracer configuration object
  * @param {Function} setWriterEnabledValue - Callback to set the writer enabled state
- * @returns {void}
  */
 function setExposureDeliveryStrategy (config, setWriterEnabledValue) {
   if (config.featureFlags?.DD_FEATURE_FLAGS_CONFIGURATION_SOURCE === 'agentless') {

package/packages/dd-trace/src/opentelemetry/logs/logger.js

@@ -112,7 +112,6 @@ class Logger {
    * Emits a log record.
    *
    * @param {LogRecord} logRecord - The log record to emit
-   * @returns {void}
    */
   emit (logRecord) {
     if (this.loggerProvider.isShutdown || !this.loggerProvider.processor) {

package/packages/dd-trace/src/opentelemetry/logs/logger_provider.js

@@ -97,7 +97,6 @@ class LoggerProvider {
 
   /**
    * Shuts down the logger provider and all associated processors.
-   * @returns {undefined} Promise that resolves when shutdown is complete
    */
   shutdown () {
     if (!this.isShutdown) {

package/packages/dd-trace/src/opentelemetry/logs/otlp_http_log_exporter.js

@@ -49,7 +49,6 @@ class OtlpHttpLogExporter extends OtlpHttpExporterBase {
    * @param {LogRecord[]} logRecords - Array of enriched log records to export
    * @param {Function} resultCallback - Callback function for export result
    *
-   * @returns {void}
    */
   export (logRecords, resultCallback) {
     if (logRecords.length === 0) {

package/packages/dd-trace/src/opentelemetry/logs/otlp_transformer.js

@@ -43,7 +43,6 @@ const NANOSECONDS_PER_SECOND = 1_000_000_000n
 /**
  * Converts an OpenTelemetry HrTime to an exact OTLP uint64 decimal string.
  * @param {import('@opentelemetry/api').HrTime} hrTime
- * @returns {string}
  */
 function encodeHrTime (hrTime) {
   return (BigInt(hrTime[0]) * NANOSECONDS_PER_SECOND + BigInt(hrTime[1])).toString()
@@ -205,7 +204,6 @@ class OtlpTransformer extends OtlpTransformerBase {
   /**
    * Maps OpenTelemetry severity number to protobuf severity number.
    * @param {number} severityNumber - OpenTelemetry severity number
-   * @returns {number} Protobuf severity number
    */
   #mapSeverityNumber (severityNumber) {
     const { protoSeverityNumber } = getProtobufTypes()

package/packages/dd-trace/src/opentelemetry/metrics/index.js

@@ -66,7 +66,7 @@ function initializeOpenTelemetryMetrics (config) {
   metrics.setGlobalMeterProvider(meterProvider)
 
   // Include the final metric collection and export in lifecycle retention.
-  registerTelemetryFlusher(done => meterProvider.forceFlush(done))
+  registerTelemetryFlusher(done => reader.forceFlush(done))
 
   registerResourceAttributeRefresh(exporter, () => buildGeneralResourceAttributes(config))
 }

package/packages/dd-trace/src/opentelemetry/metrics/meter_provider.js

@@ -51,11 +51,11 @@ class MeterProvider {
   }
 
   /**
-   * @param {Function} [done] Called after the metric export completes
+   * @param {(error: Error | null) => void} [done] Called after shutdown completes
    */
-  forceFlush (done) {
-    if (this.reader) this.reader.forceFlush(done)
-    else done?.()
+  shutdown (done) {
+    if (this.reader) this.reader.shutdown(done)
+    else done?.(null)
   }
 }
 

package/packages/dd-trace/src/opentelemetry/metrics/otlp_span_stats_transformer.js

@@ -148,7 +148,6 @@ class OtlpStatsTransformer extends OtlpTransformerBase {
    * @param {string} baseKey
    * @param {boolean} topLevel
    * @param {string} statusCode
-   * @returns {void}
    */
   #addDistribution (distributions, sketch, startNano, endNano, baseAttributes, baseKey, topLevel, statusCode) {
     if (!sketch || sketch.count === 0) return

package/packages/dd-trace/src/opentelemetry/metrics/otlp_transformer.js

@@ -237,7 +237,6 @@ class OtlpTransformer extends OtlpTransformerBase {
    *
    * @param {NumberDataPoint} dataPoint - The number data point to assign a value to
    * @param {number} value - The value to assign
-   * @returns {void}
    */
   #assignNumberValue (dataPoint, value) {
     if (Number.isInteger(value)) {