dd-trace 3.0.0 → 3.1.0

package/packages/dd-trace/src/encode/0.4.js

@@ -13,7 +13,8 @@ float64Array[0] = -1
 const bigEndian = uInt8Float64Array[7] === 0
 
 class AgentEncoder {
-  constructor (writer) {
+  constructor (writer, limit = SOFT_LIMIT) {
+    this._limit = limit
     this._traceBytes = new Chunk()
     this._stringBytes = new Chunk()
     this._writer = writer
@@ -41,7 +42,8 @@ class AgentEncoder {
     })
 
     // we can go over the soft limit since the agent has a 50MB hard limit
-    if (this._traceBytes.length > SOFT_LIMIT || this._stringBytes.length > SOFT_LIMIT) {
+    if (this._traceBytes.length > this._limit || this._stringBytes.length > this._limit) {
+      log.debug('Buffer went over soft limit, flushing')
       this._writer.flush()
     }
   }
@@ -113,29 +115,37 @@ class AgentEncoder {
 
   _encodeArrayPrefix (bytes, value) {
     const length = value.length
-    const buffer = bytes.buffer
     const offset = bytes.length
 
     bytes.reserve(5)
     bytes.length += 5
 
-    buffer[offset] = 0xdd
-    buffer[offset + 1] = length >> 24
-    buffer[offset + 2] = length >> 16
-    buffer[offset + 3] = length >> 8
-    buffer[offset + 4] = length
+    bytes.buffer[offset] = 0xdd
+    bytes.buffer[offset + 1] = length >> 24
+    bytes.buffer[offset + 2] = length >> 16
+    bytes.buffer[offset + 3] = length >> 8
+    bytes.buffer[offset + 4] = length
   }
 
-  _encodeByte (bytes, value) {
-    const buffer = bytes.buffer
+  _encodeMapPrefix (bytes, keysLength) {
+    const offset = bytes.length
 
+    bytes.reserve(5)
+    bytes.length += 5
+    bytes.buffer[offset] = 0xdf
+    bytes.buffer[offset + 1] = keysLength >> 24
+    bytes.buffer[offset + 2] = keysLength >> 16
+    bytes.buffer[offset + 3] = keysLength >> 8
+    bytes.buffer[offset + 4] = keysLength
+  }
+
+  _encodeByte (bytes, value) {
     bytes.reserve(1)
 
-    buffer[bytes.length++] = value
+    bytes.buffer[bytes.length++] = value
   }
 
   _encodeId (bytes, id) {
-    const buffer = bytes.buffer
     const offset = bytes.length
 
     bytes.reserve(9)
@@ -143,33 +153,31 @@ class AgentEncoder {
 
     id = id.toArray()
 
-    buffer[offset] = 0xcf
-    buffer[offset + 1] = id[0]
-    buffer[offset + 2] = id[1]
-    buffer[offset + 3] = id[2]
-    buffer[offset + 4] = id[3]
-    buffer[offset + 5] = id[4]
-    buffer[offset + 6] = id[5]
-    buffer[offset + 7] = id[6]
-    buffer[offset + 8] = id[7]
+    bytes.buffer[offset] = 0xcf
+    bytes.buffer[offset + 1] = id[0]
+    bytes.buffer[offset + 2] = id[1]
+    bytes.buffer[offset + 3] = id[2]
+    bytes.buffer[offset + 4] = id[3]
+    bytes.buffer[offset + 5] = id[4]
+    bytes.buffer[offset + 6] = id[5]
+    bytes.buffer[offset + 7] = id[6]
+    bytes.buffer[offset + 8] = id[7]
   }
 
   _encodeInteger (bytes, value) {
-    const buffer = bytes.buffer
     const offset = bytes.length
 
     bytes.reserve(5)
     bytes.length += 5
 
-    buffer[offset] = 0xce
-    buffer[offset + 1] = value >> 24
-    buffer[offset + 2] = value >> 16
-    buffer[offset + 3] = value >> 8
-    buffer[offset + 4] = value
+    bytes.buffer[offset] = 0xce
+    bytes.buffer[offset + 1] = value >> 24
+    bytes.buffer[offset + 2] = value >> 16
+    bytes.buffer[offset + 3] = value >> 8
+    bytes.buffer[offset + 4] = value
   }
 
   _encodeLong (bytes, value) {
-    const buffer = bytes.buffer
     const offset = bytes.length
     const hi = (value / Math.pow(2, 32)) >> 0
     const lo = value >>> 0
@@ -177,40 +185,27 @@ class AgentEncoder {
     bytes.reserve(9)
     bytes.length += 9
 
-    buffer[offset] = 0xcf
-    buffer[offset + 1] = hi >> 24
-    buffer[offset + 2] = hi >> 16
-    buffer[offset + 3] = hi >> 8
-    buffer[offset + 4] = hi
-    buffer[offset + 5] = lo >> 24
-    buffer[offset + 6] = lo >> 16
-    buffer[offset + 7] = lo >> 8
-    buffer[offset + 8] = lo
+    bytes.buffer[offset] = 0xcf
+    bytes.buffer[offset + 1] = hi >> 24
+    bytes.buffer[offset + 2] = hi >> 16
+    bytes.buffer[offset + 3] = hi >> 8
+    bytes.buffer[offset + 4] = hi
+    bytes.buffer[offset + 5] = lo >> 24
+    bytes.buffer[offset + 6] = lo >> 16
+    bytes.buffer[offset + 7] = lo >> 8
+    bytes.buffer[offset + 8] = lo
   }
 
   _encodeMap (bytes, value) {
     const keys = Object.keys(value)
-    const buffer = bytes.buffer
-    const offset = bytes.length
-
-    bytes.reserve(5)
-    bytes.length += 5
+    const validKeys = keys.filter(key => typeof value[key] === 'string' || typeof value[key] === 'number')
 
-    let length = 0
-
-    for (const key of keys) {
-      if (typeof value[key] !== 'string' && typeof value[key] !== 'number') return
-      length++
+    this._encodeMapPrefix(bytes, validKeys.length)
 
+    for (const key of validKeys) {
       this._encodeString(bytes, key)
       this._encodeValue(bytes, value[key])
     }
-
-    buffer[offset] = 0xdf
-    buffer[offset + 1] = length >> 24
-    buffer[offset + 2] = length >> 16
-    buffer[offset + 3] = length >> 8
-    buffer[offset + 4] = length
   }
 
   _encodeValue (bytes, value) {
@@ -237,21 +232,19 @@ class AgentEncoder {
   _encodeFloat (bytes, value) {
     float64Array[0] = value
 
-    const buffer = bytes.buffer
     const offset = bytes.length
-
     bytes.reserve(9)
     bytes.length += 9
 
-    buffer[offset] = 0xcb
+    bytes.buffer[offset] = 0xcb
 
     if (bigEndian) {
       for (let i = 0; i <= 7; i++) {
-        buffer[offset + i + 1] = uInt8Float64Array[i]
+        bytes.buffer[offset + i + 1] = uInt8Float64Array[i]
       }
     } else {
       for (let i = 7; i >= 0; i--) {
-        buffer[bytes.length - i - 1] = uInt8Float64Array[i]
+        bytes.buffer[bytes.length - i - 1] = uInt8Float64Array[i]
       }
     }
   }

package/packages/dd-trace/src/encode/agentless-ci-visibility.js

@@ -1,10 +1,8 @@
 'use strict'
 const { truncateSpan, normalizeSpan } = require('./tags-processors')
-const Chunk = require('./chunk')
 const { AgentEncoder } = require('./0.4')
 const { version: ddTraceVersion } = require('../../../../package.json')
 const id = require('../../../dd-trace/src/id')
-
 const ENCODING_VERSION = 1
 
 const ALLOWED_CONTENT_TYPES = ['test_session_end', 'test_suite_end', 'test']
@@ -12,7 +10,7 @@ const ALLOWED_CONTENT_TYPES = ['test_session_end', 'test_suite_end', 'test']
 const TEST_SUITE_KEYS_LENGTH = 11
 const TEST_SESSION_KEYS_LENGTH = 10
 
-const CHUNK_SIZE = 4 * 1024 * 1024 // 4MB
+const INTAKE_SOFT_LIMIT = 2 * 1024 * 1024 // 2MB
 
 function formatSpan (span) {
   let encodingVersion = ENCODING_VERSION
@@ -27,16 +25,11 @@ function formatSpan (span) {
 }
 
 class AgentlessCiVisibilityEncoder extends AgentEncoder {
-  constructor ({ runtimeId, service, env }) {
-    super(...arguments)
-    this._events = []
+  constructor (writer, { runtimeId, service, env }) {
+    super(writer, INTAKE_SOFT_LIMIT)
     this.runtimeId = runtimeId
     this.service = service
     this.env = env
-    this._traceBytes = new Chunk(CHUNK_SIZE)
-    this._stringBytes = new Chunk(CHUNK_SIZE)
-    this._stringCount = 0
-    this._stringMap = {}
 
     // Used to keep track of the number of encoded events to update the
     // length of `payload.events` when calling `makePayload`
@@ -186,35 +179,21 @@ class AgentlessCiVisibilityEncoder extends AgentEncoder {
     const lo = value >>> 0
     const flag = isPositive ? 0xcf : 0xd3
 
-    const buffer = bytes.buffer
     const offset = bytes.length
 
     // int 64
     bytes.reserve(9)
     bytes.length += 9
 
-    buffer[offset] = flag
-    buffer[offset + 1] = hi >> 24
-    buffer[offset + 2] = hi >> 16
-    buffer[offset + 3] = hi >> 8
-    buffer[offset + 4] = hi
-    buffer[offset + 5] = lo >> 24
-    buffer[offset + 6] = lo >> 16
-    buffer[offset + 7] = lo >> 8
-    buffer[offset + 8] = lo
-  }
-
-  _encodeMapPrefix (bytes, keysLength) {
-    const buffer = bytes.buffer
-    const offset = bytes.length
-
-    bytes.reserve(5)
-    bytes.length += 5
-    buffer[offset] = 0xdf
-    buffer[offset + 1] = keysLength >> 24
-    buffer[offset + 2] = keysLength >> 16
-    buffer[offset + 3] = keysLength >> 8
-    buffer[offset + 4] = keysLength
+    bytes.buffer[offset] = flag
+    bytes.buffer[offset + 1] = hi >> 24
+    bytes.buffer[offset + 2] = hi >> 16
+    bytes.buffer[offset + 3] = hi >> 8
+    bytes.buffer[offset + 4] = hi
+    bytes.buffer[offset + 5] = lo >> 24
+    bytes.buffer[offset + 6] = lo >> 16
+    bytes.buffer[offset + 7] = lo >> 8
+    bytes.buffer[offset + 8] = lo
   }
 
   _encode (bytes, trace) {
@@ -240,7 +219,7 @@ class AgentlessCiVisibilityEncoder extends AgentEncoder {
     const traceSize = bytes.length
     const buffer = Buffer.allocUnsafe(traceSize)
 
-    bytes.buffer.copy(buffer, 0, 0, bytes.length)
+    bytes.buffer.copy(buffer, 0, 0, traceSize)
 
     this.reset()
 

package/packages/dd-trace/src/encode/coverage-ci-visibility.js

@@ -0,0 +1,84 @@
+'use strict'
+const { AgentEncoder } = require('./0.4')
+const Chunk = require('./chunk')
+
+const FormData = require('../exporters/common/form-data')
+
+const COVERAGE_PAYLOAD_VERSION = 1
+const COVERAGE_KEYS_LENGTH = 4
+const MAXIMUM_NUM_COVERAGE_FILES = 100
+
+class CoverageCIVisibilityEncoder extends AgentEncoder {
+  constructor () {
+    super(...arguments)
+    this.codeCoverageBuffers = []
+    this._coverageBytes = new Chunk()
+    this.reset()
+  }
+
+  count () {
+    return this.codeCoverageBuffers.length
+  }
+
+  encode (coverage) {
+    const bytes = this._coverageBytes
+    const coverageBuffer = this.encodeCodeCoverage(bytes, coverage)
+    this.codeCoverageBuffers.push(coverageBuffer)
+    this.reset()
+  }
+
+  encodeCodeCoverage (bytes, coverage) {
+    this._encodeMapPrefix(bytes, COVERAGE_KEYS_LENGTH)
+    this._encodeString(bytes, 'version')
+    this._encodeInteger(bytes, COVERAGE_PAYLOAD_VERSION)
+    this._encodeString(bytes, 'trace_id')
+    this._encodeId(bytes, coverage.traceId)
+    this._encodeString(bytes, 'span_id')
+    this._encodeId(bytes, coverage.spanId)
+    this._encodeString(bytes, 'files')
+    this._encodeArrayPrefix(bytes, coverage.files)
+    for (const filename of coverage.files) {
+      this._encodeMapPrefix(bytes, 1)
+      this._encodeString(bytes, 'filename')
+      this._encodeString(bytes, filename)
+    }
+    const traceSize = bytes.length
+    const buffer = Buffer.allocUnsafe(traceSize)
+
+    bytes.buffer.copy(buffer, 0, 0, bytes.length)
+
+    return buffer
+  }
+
+  reset () {
+    this._reset()
+    if (this._coverageBytes) {
+      this._coverageBytes.length = 0
+    }
+  }
+
+  makePayload () {
+    const form = new FormData()
+
+    let coverageFileIndex = 1
+
+    for (const coverageBuffer of this.codeCoverageBuffers.slice(0, MAXIMUM_NUM_COVERAGE_FILES)) {
+      const coverageFilename = `coverage${coverageFileIndex++}`
+      form.append(
+        coverageFilename,
+        coverageBuffer,
+        {
+          filename: `${coverageFilename}.msgpack`,
+          contentType: 'application/msgpack'
+        }
+      )
+    }
+    // 'event' is a backend requirement
+    form.append('event', JSON.stringify({}), { filename: 'event.json', contentType: 'application/json' })
+    this.codeCoverageBuffers = this.codeCoverageBuffers.slice(MAXIMUM_NUM_COVERAGE_FILES)
+
+    return form
+  }
+}
+
+module.exports = { CoverageCIVisibilityEncoder }

package/packages/dd-trace/src/exporters/agent/index.js

@@ -3,17 +3,16 @@
 const URL = require('url').URL
 const log = require('../../log')
 const Writer = require('./writer')
-const Scheduler = require('../scheduler')
 
 class AgentExporter {
-  constructor ({ url, hostname, port, flushInterval, lookup, protocolVersion }, prioritySampler) {
+  constructor (config, prioritySampler) {
+    this._config = config
+    const { url, hostname, port, lookup, protocolVersion } = config
     this._url = url || new URL(`http://${hostname || 'localhost'}:${port}`)
     this._writer = new Writer({ url: this._url, prioritySampler, lookup, protocolVersion })
 
-    if (flushInterval > 0) {
-      this._scheduler = new Scheduler(() => this._writer.flush(), flushInterval)
-    }
-    this._scheduler && this._scheduler.start()
+    this._timer = undefined
+    process.once('beforeExit', () => this._writer.flush())
   }
 
   setUrl (url) {
@@ -29,8 +28,15 @@ class AgentExporter {
   export (spans) {
     this._writer.append(spans)
 
-    if (!this._scheduler) {
+    const { flushInterval } = this._config
+
+    if (flushInterval === 0) {
       this._writer.flush()
+    } else if (flushInterval > 0 && !this._timer) {
+      this._timer = setTimeout(() => {
+        this._writer.flush()
+        this._timer = clearTimeout(this._timer)
+      }, flushInterval).unref()
     }
   }
 }

package/packages/dd-trace/src/exporters/agent/writer.js

@@ -99,7 +99,7 @@ function makeRequest (version, data, count, url, lookup, needsStartupLog, cb) {
 
   log.debug(() => `Request to the agent: ${JSON.stringify(options)}`)
 
-  request(data, options, true, (err, res, status) => {
+  request(data, options, (err, res, status) => {
     if (needsStartupLog) {
       // Note that logging will only happen once, regardless of how many times this is called.
       startupLog({

package/packages/dd-trace/src/exporters/common/request.js

@@ -3,10 +3,12 @@
 // TODO: Add test with slow or unresponsive agent.
 // TODO: Add telemetry for things like dropped requests, errors, etc.
 
+const { Readable } = require('stream')
 const http = require('http')
 const https = require('https')
 const docker = require('./docker')
 const { storage } = require('../../../../datadog-core')
+const log = require('../../log')
 
 const keepAlive = true
 const maxTotalSockets = 1
@@ -17,26 +19,28 @@ const containerId = docker.id()
 
 let activeRequests = 0
 
-function request (data, options, keepAlive, callback) {
+function request (data, options, callback) {
   if (!options.headers) {
     options.headers = {}
   }
 
+  const isReadable = data instanceof Readable
+
   // The timeout should be kept low to avoid excessive queueing.
   const timeout = options.timeout || 2000
   const isSecure = options.protocol === 'https:'
   const client = isSecure ? https : http
   const dataArray = [].concat(data)
 
-  options.headers['Content-Length'] = byteLength(dataArray)
+  if (!isReadable) {
+    options.headers['Content-Length'] = byteLength(dataArray)
+  }
 
   if (containerId) {
     options.headers['Datadog-Container-ID'] = containerId
   }
 
-  if (keepAlive) {
-    options.agent = isSecure ? httpsAgent : httpAgent
-  }
+  options.agent = isSecure ? httpsAgent : httpAgent
 
   const onResponse = res => {
     let responseData = ''
@@ -59,7 +63,10 @@ function request (data, options, keepAlive, callback) {
   }
 
   const makeRequest = onError => {
-    if (!request.writable) return callback(null)
+    if (!request.writable) {
+      log.debug('Maximum number of active requests reached: payload is discarded.')
+      return callback(null)
+    }
 
     activeRequests++
 
@@ -74,10 +81,14 @@ function request (data, options, keepAlive, callback) {
       onError(err)
     })
 
-    dataArray.forEach(buffer => req.write(buffer))
-
     req.setTimeout(timeout, req.abort)
-    req.end()
+
+    if (isReadable) {
+      data.pipe(req)
+    } else {
+      dataArray.forEach(buffer => req.write(buffer))
+      req.end()
+    }
 
     storage.enterWith(store)
   }

package/packages/dd-trace/src/exporters/common/writer.js

@@ -23,16 +23,19 @@ class Writer {
     }
   }
 
-  append (spans) {
-    if (!request.writable) return
+  append (payload) {
+    if (!request.writable) {
+      log.debug(() => `Maximum number of active requests reached. Payload discarded: ${JSON.stringify(payload)}`)
+      return
+    }
 
-    log.debug(() => `Encoding trace: ${JSON.stringify(spans)}`)
+    log.debug(() => `Encoding payload: ${JSON.stringify(payload)}`)
 
-    this._encode(spans)
+    this._encode(payload)
   }
 
-  _encode (trace) {
-    this._encoder.encode(trace)
+  _encode (payload) {
+    this._encoder.encode(payload)
   }
 
   setUrl (url) {

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

@@ -0,0 +1,10 @@
+'use strict'
+
+const { isFalse } = require('./util')
+
+// Global `jest` is only present in Jest workers.
+const inJestWorker = typeof jest !== 'undefined'
+
+module.exports = isFalse(process.env.DD_TRACE_ENABLED) || inJestWorker
+  ? require('./noop/proxy')
+  : require('./proxy')

package/packages/dd-trace/src/noop/proxy.js

@@ -0,0 +1,77 @@
+'use strict'
+
+const NoopTracer = require('./tracer')
+
+const noop = new NoopTracer()
+
+class Tracer {
+  constructor () {
+    this._tracer = noop
+  }
+
+  init () {
+    return this
+  }
+
+  use () {
+    return this
+  }
+
+  trace (name, options, fn) {
+    if (!fn) {
+      fn = options
+      options = {}
+    }
+
+    if (typeof fn !== 'function') return
+
+    options = options || {}
+
+    return this._tracer.trace(name, options, fn)
+  }
+
+  wrap (name, options, fn) {
+    if (!fn) {
+      fn = options
+      options = {}
+    }
+
+    if (typeof fn !== 'function') return fn
+
+    options = options || {}
+
+    return this._tracer.wrap(name, options, fn)
+  }
+
+  setUrl () {
+    this._tracer.setUrl.apply(this._tracer, arguments)
+    return this
+  }
+
+  startSpan () {
+    return this._tracer.startSpan.apply(this._tracer, arguments)
+  }
+
+  inject () {
+    return this._tracer.inject.apply(this._tracer, arguments)
+  }
+
+  extract () {
+    return this._tracer.extract.apply(this._tracer, arguments)
+  }
+
+  scope () {
+    return this._tracer.scope.apply(this._tracer, arguments)
+  }
+
+  getRumData () {
+    return this._tracer.getRumData.apply(this._tracer, arguments)
+  }
+
+  setUser () {
+    this._tracer.setUser.apply(this._tracer, arguments)
+    return this
+  }
+}
+
+module.exports = Tracer

package/packages/dd-trace/src/plugin_manager.js

@@ -120,7 +120,8 @@ module.exports = class PluginManager {
       logInjection,
       serviceMapping,
       experimental,
-      queryStringObfuscation
+      queryStringObfuscation,
+      isIntelligentTestRunnerEnabled
     } = this._tracerConfig
 
     const sharedConfig = {}
@@ -133,11 +134,12 @@ module.exports = class PluginManager {
       sharedConfig.queryStringObfuscation = queryStringObfuscation
     }
 
-    // TODO: update so that it's available for every CI Visibility's plugin
-    if (name === 'mocha') {
-      sharedConfig.isAgentlessEnabled = experimental && experimental.exporter === 'datadog'
+    if (experimental) {
+      sharedConfig.isAgentlessEnabled = experimental.exporter === 'datadog'
     }
 
+    sharedConfig.isIntelligentTestRunnerEnabled = isIntelligentTestRunnerEnabled
+
     if (serviceMapping && serviceMapping[name]) {
       sharedConfig.service = serviceMapping[name]
     }