dd-trace 3.12.1 → 3.15.0

package/packages/dd-trace/src/opentracing/propagation/text_map.js

@@ -4,6 +4,7 @@ const pick = require('lodash.pick')
 const id = require('../../id')
 const DatadogSpanContext = require('../span_context')
 const log = require('../../log')
+const TraceState = require('./tracestate')
 
 const { AUTO_KEEP, AUTO_REJECT, USER_KEEP } = require('../../../../../ext/priority')
 
@@ -29,8 +30,15 @@ const tagValueExpr = /^[\x20-\x2b\x2d-\x7e]*$/ // ASCII minus commas
 const ddKeys = [traceKey, spanKey, samplingKey, originKey]
 const b3Keys = [b3TraceKey, b3SpanKey, b3ParentKey, b3SampledKey, b3FlagsKey, b3HeaderKey]
 const logKeys = ddKeys.concat(b3Keys)
-const traceparentExpr = /^(\d{2})-([A-Fa-f0-9]{32})-([A-Fa-f0-9]{16})-(\d{2})$/i
+const traceparentExpr = /^([a-f0-9]{2})-([a-f0-9]{32})-([a-f0-9]{16})-([a-f0-9]{2})(-.*)?$/i
 const traceparentKey = 'traceparent'
+// Origin value in tracestate replaces '~', ',' and ';' with '_"
+const tracestateOriginFilter = /[^\x20-\x2b\x2d-\x3a\x3c-\x7d]/g
+// Tag keys in tracestate replace ' ', ',' and '=' with '_'
+const tracestateTagKeyFilter = /[^\x21-\x2b\x2d-\x3c\x3e-\x7e]/g
+// Tag values in tracestate replace ',', '~' and ';' with '_'
+const tracestateTagValueFilter = /[^\x20-\x2b\x2d-\x3a\x3c-\x7d]/g
+const invalidSegment = /^0+$/
 
 class TextMapPropagator {
   constructor (config) {
@@ -38,15 +46,11 @@ class TextMapPropagator {
   }
 
   inject (spanContext, carrier) {
-    carrier[traceKey] = spanContext.toTraceId()
-    carrier[spanKey] = spanContext.toSpanId()
-
-    this._injectOrigin(spanContext, carrier)
-    this._injectSamplingPriority(spanContext, carrier)
     this._injectBaggageItems(spanContext, carrier)
-    this._injectB3(spanContext, carrier)
+    this._injectDatadog(spanContext, carrier)
+    this._injectB3MultipleHeaders(spanContext, carrier)
+    this._injectB3SingleHeader(spanContext, carrier)
     this._injectTraceparent(spanContext, carrier)
-    this._injectTags(spanContext, carrier)
 
     log.debug(() => `Inject into carrier: ${JSON.stringify(pick(carrier, logKeys))}.`)
   }
@@ -61,6 +65,17 @@ class TextMapPropagator {
     return spanContext
   }
 
+  _injectDatadog (spanContext, carrier) {
+    if (!this._hasPropagationStyle('inject', 'datadog')) return
+
+    carrier[traceKey] = spanContext.toTraceId()
+    carrier[spanKey] = spanContext.toSpanId()
+
+    this._injectOrigin(spanContext, carrier)
+    this._injectSamplingPriority(spanContext, carrier)
+    this._injectTags(spanContext, carrier)
+  }
+
   _injectOrigin (spanContext, carrier) {
     const origin = spanContext._trace.origin
 
@@ -112,8 +127,10 @@ class TextMapPropagator {
     }
   }
 
-  _injectB3 (spanContext, carrier) {
-    if (!this._config.experimental.b3) return
+  _injectB3MultipleHeaders (spanContext, carrier) {
+    const hasB3 = this._hasPropagationStyle('inject', 'b3')
+    const hasB3multi = this._hasPropagationStyle('inject', 'b3multi')
+    if (!(hasB3 || hasB3multi)) return
 
     carrier[b3TraceKey] = spanContext._traceId.toString(16)
     carrier[b3SpanKey] = spanContext._spanId.toString(16)
@@ -128,16 +145,92 @@ class TextMapPropagator {
     }
   }
 
+  _injectB3SingleHeader (spanContext, carrier) {
+    const hasB3SingleHeader = this._hasPropagationStyle('inject', 'b3 single header')
+    if (!hasB3SingleHeader) return null
+
+    const traceId = spanContext._traceId.toString(16)
+    const spanId = spanContext._spanId.toString(16)
+    const sampled = spanContext._sampling.priority >= AUTO_KEEP ? '1' : '0'
+
+    carrier[b3HeaderKey] = `${traceId}-${spanId}-${sampled}`
+    if (spanContext._parentId) {
+      carrier[b3HeaderKey] += '-' + spanContext._parentId.toString(16)
+    }
+  }
+
   _injectTraceparent (spanContext, carrier) {
-    if (!this._config.experimental.traceparent) return
+    if (!this._hasPropagationStyle('inject', 'tracecontext')) return
+
+    const {
+      _sampling: { priority, mechanism },
+      _tracestate: ts = new TraceState(),
+      _trace: { origin, tags }
+    } = spanContext
+
     carrier[traceparentKey] = spanContext.toTraceparent()
+
+    ts.forVendor('dd', state => {
+      state.set('s', priority)
+      if (mechanism) {
+        state.set('t.dm', mechanism)
+      }
+
+      if (typeof origin === 'string') {
+        const originValue = origin
+          .replace(tracestateOriginFilter, '_')
+          .replace(/[\x3d]/g, '~')
+
+        state.set('o', originValue)
+      }
+
+      for (const key in tags) {
+        if (!tags[key] || !key.startsWith('_dd.p.')) continue
+
+        const tagKey = 't.' + key.slice(6)
+          .replace(tracestateTagKeyFilter, '_')
+
+        const tagValue = tags[key]
+          .toString()
+          .replace(tracestateTagValueFilter, '_')
+          .replace(/[\x3d]/g, '~')
+
+        state.set(tagKey, tagValue)
+      }
+    })
+
+    carrier.tracestate = ts.toString()
+  }
+
+  _hasPropagationStyle (mode, name) {
+    return this._config.tracePropagationStyle[mode].includes(name)
   }
 
   _extractSpanContext (carrier) {
-    return this._extractDatadogContext(carrier) ||
-      this._extractTraceparentContext(carrier) ||
-      this._extractB3Context(carrier) ||
-      this._extractSqsdContext(carrier)
+    for (const extractor of this._config.tracePropagationStyle.extract) {
+      let spanContext = null
+      switch (extractor) {
+        case 'datadog':
+          spanContext = this._extractDatadogContext(carrier)
+          break
+        case 'tracecontext':
+          spanContext = this._extractTraceparentContext(carrier)
+          break
+        case 'b3': // TODO: should match "b3 single header" in next major
+        case 'b3multi':
+          spanContext = this._extractB3MultiContext(carrier)
+          break
+        case 'b3 single header': // TODO: delete in major after singular "b3"
+          spanContext = this._extractB3SingleContext(carrier)
+          break
+      }
+
+      if (spanContext !== null) {
+        return spanContext
+      }
+    }
+
+    return this._extractSqsdContext(carrier)
   }
 
   _extractDatadogContext (carrier) {
@@ -153,10 +246,20 @@ class TextMapPropagator {
     return spanContext
   }
 
-  _extractB3Context (carrier) {
-    if (!this._config.experimental.b3) return null
+  _extractB3MultiContext (carrier) {
+    const b3 = this._extractB3MultipleHeaders(carrier)
+    if (!b3) return null
+    return this._extractB3Context(b3)
+  }
+
+  _extractB3SingleContext (carrier) {
+    if (!b3HeaderExpr.test(carrier[b3HeaderKey])) return null
+    const b3 = this._extractB3SingleHeader(carrier)
+    if (!b3) return null
+    return this._extractB3Context(b3)
+  }
 
-    const b3 = this._extractB3Headers(carrier)
+  _extractB3Context (b3) {
     const debug = b3[b3FlagsKey] === '1'
     const priority = this._getPriority(b3[b3SampledKey], debug)
     const spanContext = this._extractGenericContext(b3, b3TraceKey, b3SpanKey, 16)
@@ -192,25 +295,75 @@ class TextMapPropagator {
   }
 
   _extractTraceparentContext (carrier) {
-    if (!this._config.experimental.traceparent) return null
-
     const headerValue = carrier[traceparentKey]
     if (!headerValue) {
       return null
     }
-    const matches = headerValue.match(traceparentExpr)
+    const matches = headerValue.trim().match(traceparentExpr)
     if (matches.length) {
-      return new DatadogSpanContext({
-        traceId: id(matches[2], 16),
-        spanId: id(matches[3], 16),
-        sampling: { priority: matches[4] === '01' ? 1 : 0 }
+      const [ version, traceId, spanId, flags, tail ] = matches.slice(1)
+      const traceparent = { version }
+      const tracestate = TraceState.fromString(carrier.tracestate)
+      if (invalidSegment.test(traceId)) return null
+      if (invalidSegment.test(spanId)) return null
+
+      // Version ff is considered invalid
+      if (version === 'ff') return null
+
+      // Version 00 should have no tail, but future versions may
+      if (tail && version === '00') return null
+
+      const spanContext = new DatadogSpanContext({
+        traceId: id(traceId, 16),
+        spanId: id(spanId, 16),
+        sampling: { priority: parseInt(flags, 10) & 1 ? 1 : 0 },
+        traceparent,
+        tracestate
       })
+
+      tracestate.forVendor('dd', state => {
+        for (const [key, value] of state.entries()) {
+          switch (key) {
+            case 's': {
+              const priority = parseInt(value, 10)
+              if (!Number.isInteger(priority)) continue
+              if (
+                (spanContext._sampling.priority === 1 && priority > 0) ||
+                (spanContext._sampling.priority === 0 && priority < 0)
+              ) {
+                spanContext._sampling.priority = priority
+              }
+              break
+            }
+            case 'o':
+              spanContext._trace.origin = value
+              break
+            case 't.dm': {
+              const mechanism = parseInt(value, 10)
+              if (Number.isInteger(mechanism)) {
+                spanContext._sampling.mechanism = mechanism
+                spanContext._trace.tags['_dd.p.dm'] = mechanism
+              }
+              break
+            }
+            default:
+              if (!key.startsWith('t.')) continue
+              spanContext._trace.tags[`_dd.p.${key.slice(2)}`] = value
+                .replace(/[\x7e]/gm, '=')
+          }
+        }
+      })
+
+      this._extractBaggageItems(carrier, spanContext)
+      return spanContext
     }
     return null
   }
 
   _extractGenericContext (carrier, traceKey, spanKey, radix) {
     if (carrier[traceKey] && carrier[spanKey]) {
+      if (invalidSegment.test(carrier[traceKey])) return null
+
       return new DatadogSpanContext({
         traceId: id(carrier[traceKey], radix),
         spanId: id(carrier[spanKey], radix)
@@ -220,35 +373,34 @@ class TextMapPropagator {
     return null
   }
 
-  _extractB3Headers (carrier) {
-    if (b3HeaderExpr.test(carrier[b3HeaderKey])) {
-      return this._extractB3SingleHeader(carrier)
-    } else {
-      return this._extractB3MultipleHeaders(carrier)
-    }
-  }
-
   _extractB3MultipleHeaders (carrier) {
+    let empty = true
     const b3 = {}
 
     if (b3TraceExpr.test(carrier[b3TraceKey]) && b3SpanExpr.test(carrier[b3SpanKey])) {
       b3[b3TraceKey] = carrier[b3TraceKey]
       b3[b3SpanKey] = carrier[b3SpanKey]
+      empty = false
     }
 
     if (carrier[b3SampledKey]) {
       b3[b3SampledKey] = carrier[b3SampledKey]
+      empty = false
     }
 
     if (carrier[b3FlagsKey]) {
       b3[b3FlagsKey] = carrier[b3FlagsKey]
+      empty = false
     }
 
-    return b3
+    return empty ? null : b3
   }
 
   _extractB3SingleHeader (carrier) {
-    const parts = carrier[b3HeaderKey].split('-')
+    const header = carrier[b3HeaderKey]
+    if (!header) return null
+
+    const parts = header.split('-')
 
     if (parts[0] === 'd') {
       return {
@@ -299,7 +451,7 @@ class TextMapPropagator {
     const priority = parseInt(carrier[samplingKey], 10)
 
     if (Number.isInteger(priority)) {
-      spanContext._sampling.priority = parseInt(carrier[samplingKey], 10)
+      spanContext._sampling.priority = priority
     }
   }
 

package/packages/dd-trace/src/opentracing/propagation/tracestate.js

@@ -0,0 +1,99 @@
+'use strict'
+
+const traceStateRegex = /[ \t]*([^=]+)=([ \t]*[^, \t]+)[ \t]*(,|$)/gim
+const traceStateDataRegex = /([^:]+):([^;]+)(;|$)/gim
+
+function fromString (Type, regex, value) {
+  if (typeof value !== 'string' || !value.length) {
+    return new Type()
+  }
+
+  const values = []
+  for (const row of value.matchAll(regex)) {
+    values.unshift(row.slice(1, 3))
+  }
+
+  return new Type(values)
+}
+
+function toString (map, pairSeparator, fieldSeparator) {
+  return Array.from(map.entries())
+    .reverse()
+    .map((pair) => pair.join(pairSeparator))
+    .join(fieldSeparator)
+}
+
+class TraceStateData extends Map {
+  constructor (...args) {
+    super(...args)
+    this.changed = false
+  }
+
+  set (...args) {
+    if (this.has(args[0]) && this.get(args[0]) === args[1]) {
+      return
+    }
+    this.changed = true
+    return super.set(...args)
+  }
+
+  delete (...args) {
+    this.changed = true
+    return super.delete(...args)
+  }
+
+  clear (...args) {
+    this.changed = true
+    return super.clear(...args)
+  }
+
+  static fromString (value) {
+    return fromString(TraceStateData, traceStateDataRegex, value)
+  }
+
+  toString () {
+    return toString(this, ':', ';')
+  }
+}
+
+/**
+ * Pairs are stored in reverse of the serialized format to rely on set ordering
+ * new entries at the end to express update movement.
+ */
+class TraceState extends Map {
+  // Delete entries on update to ensure they're moved to the end of the list
+  set (key, value) {
+    if (this.has(key)) {
+      this.delete(key)
+    }
+
+    return super.set(key, value)
+  }
+
+  forVendor (vendor, handle) {
+    const data = super.get(vendor)
+    const state = TraceStateData.fromString(data)
+    const result = handle(state)
+
+    if (state.changed) {
+      const value = state.toString()
+      if (value) {
+        this.set(vendor, state.toString())
+      } else {
+        this.delete(vendor)
+      }
+    }
+
+    return result
+  }
+
+  static fromString (value) {
+    return fromString(TraceState, traceStateRegex, value)
+  }
+
+  toString () {
+    return toString(this, '=', ',')
+  }
+}
+
+module.exports = TraceState

package/packages/dd-trace/src/opentracing/span.js

@@ -150,7 +150,8 @@ class DatadogSpan {
         parentId: parent._spanId,
         sampling: parent._sampling,
         baggageItems: Object.assign({}, parent._baggageItems),
-        trace: parent._trace
+        trace: parent._trace,
+        tracestate: parent._tracestate
       })
     } else {
       const spanId = id()

package/packages/dd-trace/src/opentracing/span_context.js

@@ -12,8 +12,10 @@ class DatadogSpanContext {
     this._name = props.name
     this._isFinished = props.isFinished || false
     this._tags = props.tags || {}
-    this._sampling = props.sampling || {}
+    this._sampling = Object.assign({}, props.sampling)
     this._baggageItems = props.baggageItems || {}
+    this._traceparent = props.traceparent
+    this._tracestate = props.tracestate
     this._noop = props.noop || null
     this._trace = props.trace || {
       started: [],
@@ -31,10 +33,11 @@ class DatadogSpanContext {
   }
 
   toTraceparent () {
-    const sampling = this._sampling.priority >= AUTO_KEEP ? '01' : '00'
+    const flags = this._sampling.priority >= AUTO_KEEP ? '01' : '00'
     const traceId = this._traceId.toString(16).padStart(32, '0')
     const spanId = this._spanId.toString(16).padStart(16, '0')
-    return `01-${traceId}-${spanId}-${sampling}`
+    const version = (this._traceparent && this._traceparent.version) || '00'
+    return `${version}-${traceId}-${spanId}-${flags}`
   }
 }
 

package/packages/dd-trace/src/plugins/ci_plugin.js

@@ -5,11 +5,18 @@ const {
   getTestCommonTags,
   getCodeOwnersForFilename,
   TEST_CODE_OWNERS,
-  CI_APP_ORIGIN
+  CI_APP_ORIGIN,
+  getTestSessionCommonTags,
+  getTestModuleCommonTags,
+  TEST_SUITE_ID,
+  TEST_MODULE_ID,
+  TEST_SESSION_ID,
+  TEST_COMMAND,
+  TEST_BUNDLE
 } = require('./util/test')
-const { COMPONENT } = require('../constants')
-
 const Plugin = require('./plugin')
+const { COMPONENT } = require('../constants')
+const log = require('../log')
 
 module.exports = class CiPlugin extends Plugin {
   constructor (...args) {
@@ -20,7 +27,9 @@ module.exports = class CiPlugin extends Plugin {
         return onDone({ err: new Error('CI Visibility was not initialized correctly') })
       }
       this.tracer._exporter.getItrConfiguration(this.testConfiguration, (err, itrConfig) => {
-        if (!err) {
+        if (err) {
+          log.error(`Error fetching intelligent test runner configuration: ${err.message}`)
+        } else {
           this.itrConfig = itrConfig
         }
         onDone({ err, itrConfig })
@@ -32,9 +41,40 @@ module.exports = class CiPlugin extends Plugin {
         return onDone({ err: new Error('CI Visibility was not initialized correctly') })
       }
       this.tracer._exporter.getSkippableSuites(this.testConfiguration, (err, skippableSuites) => {
+        if (err) {
+          log.error(`Error fetching skippable suites: ${err.message}`)
+        }
         onDone({ err, skippableSuites })
       })
     })
+
+    this.addSub(`ci:${this.constructor.name}:session:start`, ({ command, frameworkVersion, rootDir }) => {
+      const childOf = getTestParentSpan(this.tracer)
+      const testSessionSpanMetadata = getTestSessionCommonTags(command, frameworkVersion)
+      const testModuleSpanMetadata = getTestModuleCommonTags(command, frameworkVersion)
+
+      this.command = command
+      this.frameworkVersion = frameworkVersion
+      // only for playwright
+      this.rootDir = rootDir
+
+      this.testSessionSpan = this.tracer.startSpan(`${this.constructor.name}.test_session`, {
+        childOf,
+        tags: {
+          [COMPONENT]: this.constructor.name,
+          ...this.testEnvironmentMetadata,
+          ...testSessionSpanMetadata
+        }
+      })
+      this.testModuleSpan = this.tracer.startSpan(`${this.constructor.name}.test_module`, {
+        childOf: this.testSessionSpan,
+        tags: {
+          [COMPONENT]: this.constructor.name,
+          ...this.testEnvironmentMetadata,
+          ...testModuleSpanMetadata
+        }
+      })
+    })
   }
 
   configure (config) {
@@ -65,25 +105,45 @@ module.exports = class CiPlugin extends Plugin {
     }
   }
 
-  startTestSpan (name, suite, extraTags, childOf) {
-    const parent = childOf || getTestParentSpan(this.tracer)
-    const testCommonTags = getTestCommonTags(name, suite, this.tracer._version)
+  startTestSpan (testName, testSuite, testSuiteSpan, extraTags = {}) {
+    const childOf = getTestParentSpan(this.tracer)
 
-    const testTags = {
-      ...testCommonTags,
+    let testTags = {
+      ...getTestCommonTags(testName, testSuite, this.frameworkVersion),
       [COMPONENT]: this.constructor.name,
       ...extraTags
     }
 
-    const codeOwners = getCodeOwnersForFilename(suite, this.codeOwnersEntries)
-
+    const codeOwners = getCodeOwnersForFilename(testSuite, this.codeOwnersEntries)
     if (codeOwners) {
       testTags[TEST_CODE_OWNERS] = codeOwners
     }
 
+    if (testSuiteSpan) {
+      // This is a hack to get good time resolution on test events, while keeping
+      // the test event as the root span of its trace.
+      childOf._trace.startTime = testSuiteSpan.context()._trace.startTime
+      childOf._trace.ticks = testSuiteSpan.context()._trace.ticks
+
+      const suiteTags = {
+        [TEST_SUITE_ID]: testSuiteSpan.context().toSpanId(),
+        [TEST_SESSION_ID]: testSuiteSpan.context().toTraceId(),
+        [TEST_COMMAND]: testSuiteSpan.context()._tags[TEST_COMMAND],
+        [TEST_BUNDLE]: testSuiteSpan.context()._tags[TEST_COMMAND]
+      }
+      if (testSuiteSpan.context()._parentId) {
+        suiteTags[TEST_MODULE_ID] = testSuiteSpan.context()._parentId.toString(10)
+      }
+
+      testTags = {
+        ...testTags,
+        ...suiteTags
+      }
+    }
+
     const testSpan = this.tracer
       .startSpan(`${this.constructor.name}.test`, {
-        childOf: parent,
+        childOf,
         tags: {
           ...this.testEnvironmentMetadata,
           ...testTags

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

@@ -1,7 +1,9 @@
 'use strict'
 
 module.exports = {
+  get '@aws-sdk/smithy-client' () { return require('../../../datadog-plugin-aws-sdk/src') },
   get '@cucumber/cucumber' () { return require('../../../datadog-plugin-cucumber/src') },
+  get '@playwright/test' () { return require('../../../datadog-plugin-playwright/src') },
   get '@elastic/elasticsearch' () { return require('../../../datadog-plugin-elasticsearch/src') },
   get '@elastic/transport' () { return require('../../../datadog-plugin-elasticsearch/src') },
   get '@google-cloud/pubsub' () { return require('../../../datadog-plugin-google-cloud-pubsub/src') },