dd-trace 5.0.0 → 5.2.0

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

@@ -2,7 +2,8 @@
 const { truncateSpan, normalizeSpan } = require('./tags-processors')
 const { AgentEncoder } = require('./0.4')
 const { version: ddTraceVersion } = require('../../../../package.json')
-const id = require('../../../dd-trace/src/id')
+const { ITR_CORRELATION_ID } = require('../../src/plugins/util/test')
+const id = require('../../src/id')
 const {
   distributionMetric,
   TELEMETRY_ENDPOINT_PAYLOAD_SERIALIZATION_MS,
@@ -45,7 +46,13 @@ class AgentlessCiVisibilityEncoder extends AgentEncoder {
   }
 
   _encodeTestSuite (bytes, content) {
-    this._encodeMapPrefix(bytes, TEST_SUITE_KEYS_LENGTH)
+    let keysLength = TEST_SUITE_KEYS_LENGTH
+    const itrCorrelationId = content.meta[ITR_CORRELATION_ID]
+    if (itrCorrelationId) {
+      keysLength++
+    }
+
+    this._encodeMapPrefix(bytes, keysLength)
     this._encodeString(bytes, 'type')
     this._encodeString(bytes, content.type)
 
@@ -58,6 +65,12 @@ class AgentlessCiVisibilityEncoder extends AgentEncoder {
     this._encodeString(bytes, 'test_suite_id')
     this._encodeId(bytes, content.span_id)
 
+    if (itrCorrelationId) {
+      this._encodeString(bytes, ITR_CORRELATION_ID)
+      this._encodeString(bytes, itrCorrelationId)
+      delete content.meta[ITR_CORRELATION_ID]
+    }
+
     this._encodeString(bytes, 'error')
     this._encodeNumber(bytes, content.error)
     this._encodeString(bytes, 'name')
@@ -144,6 +157,10 @@ class AgentlessCiVisibilityEncoder extends AgentEncoder {
     if (content.meta.test_suite_id) {
       totalKeysLength = totalKeysLength + 1
     }
+    const itrCorrelationId = content.meta[ITR_CORRELATION_ID]
+    if (itrCorrelationId) {
+      totalKeysLength = totalKeysLength + 1
+    }
     this._encodeMapPrefix(bytes, totalKeysLength)
     if (content.type) {
       this._encodeString(bytes, 'type')
@@ -194,6 +211,12 @@ class AgentlessCiVisibilityEncoder extends AgentEncoder {
       delete content.meta.test_suite_id
     }
 
+    if (itrCorrelationId) {
+      this._encodeString(bytes, ITR_CORRELATION_ID)
+      this._encodeString(bytes, itrCorrelationId)
+      delete content.meta[ITR_CORRELATION_ID]
+    }
+
     this._encodeString(bytes, 'meta')
     this._encodeMap(bytes, content.meta)
     this._encodeString(bytes, 'metrics')

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

@@ -1,6 +1,6 @@
 'use strict'
 
-const pick = require('lodash.pick')
+const pick = require('../../../../utils/src/pick')
 const id = require('../../id')
 const DatadogSpanContext = require('../span_context')
 const log = require('../../log')

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

@@ -15,7 +15,8 @@ const {
   TEST_MODULE,
   getTestSuiteCommonTags,
   TEST_STATUS,
-  TEST_SKIPPED_BY_ITR
+  TEST_SKIPPED_BY_ITR,
+  ITR_CORRELATION_ID
 } = require('./util/test')
 const Plugin = require('./plugin')
 const { COMPONENT } = require('../constants')
@@ -53,11 +54,13 @@ module.exports = class CiPlugin extends Plugin {
       if (!this.tracer._exporter || !this.tracer._exporter.getSkippableSuites) {
         return onDone({ err: new Error('CI Visibility was not initialized correctly') })
       }
-      this.tracer._exporter.getSkippableSuites(this.testConfiguration, (err, skippableSuites) => {
+      this.tracer._exporter.getSkippableSuites(this.testConfiguration, (err, skippableSuites, itrCorrelationId) => {
         if (err) {
           log.error(`Skippable suites could not be fetched. ${err.message}`)
+        } else {
+          this.itrCorrelationId = itrCorrelationId
         }
-        onDone({ err, skippableSuites })
+        onDone({ err, skippableSuites, itrCorrelationId })
       })
     })
 
@@ -95,6 +98,9 @@ module.exports = class CiPlugin extends Plugin {
       const testCommand = this.testSessionSpan.context()._tags[TEST_COMMAND]
       skippedSuites.forEach((testSuite) => {
         const testSuiteMetadata = getTestSuiteCommonTags(testCommand, frameworkVersion, testSuite, this.constructor.id)
+        if (this.itrCorrelationId) {
+          testSuiteMetadata[ITR_CORRELATION_ID] = this.itrCorrelationId
+        }
 
         this.tracer.startSpan(`${this.constructor.id}.test_suite`, {
           childOf: this.testModuleSpan,

package/packages/dd-trace/src/plugins/util/test.js

@@ -60,6 +60,7 @@ const TEST_ITR_SKIPPING_COUNT = 'test.itr.tests_skipping.count'
 const TEST_CODE_COVERAGE_ENABLED = 'test.code_coverage.enabled'
 const TEST_ITR_UNSKIPPABLE = 'test.itr.unskippable'
 const TEST_ITR_FORCED_RUN = 'test.itr.forced_run'
+const ITR_CORRELATION_ID = 'itr_correlation_id'
 
 const TEST_CODE_COVERAGE_LINES_PCT = 'test.code_coverage.lines_pct'
 
@@ -111,6 +112,7 @@ module.exports = {
   TEST_CODE_COVERAGE_LINES_PCT,
   TEST_ITR_UNSKIPPABLE,
   TEST_ITR_FORCED_RUN,
+  ITR_CORRELATION_ID,
   addIntelligentTestRunnerSpanTags,
   getCoveredFilenamesFromCoverage,
   resetCoverage,

package/packages/dd-trace/src/plugins/util/web.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const uniq = require('lodash.uniq')
+const uniq = require('../../../../utils/src/uniq')
 const analyticsSampler = require('../../analytics_sampler')
 const FORMAT_HTTP_HEADERS = 'http_headers'
 const log = require('../../log')

package/packages/dd-trace/src/profiling/config.js

@@ -40,6 +40,7 @@ class Config {
       DD_PROFILING_EXPERIMENTAL_OOM_HEAP_LIMIT_EXTENSION_SIZE,
       DD_PROFILING_EXPERIMENTAL_OOM_MAX_HEAP_EXTENSION_COUNT,
       DD_PROFILING_EXPERIMENTAL_OOM_EXPORT_STRATEGIES,
+      DD_PROFILING_TIMELINE_ENABLED,
       DD_PROFILING_EXPERIMENTAL_TIMELINE_ENABLED,
       DD_PROFILING_CODEHOTSPOTS_ENABLED,
       DD_PROFILING_ENDPOINT_COLLECTION_ENABLED,
@@ -96,11 +97,15 @@ class Config {
     // depending on those (code hotspots and endpoint collection) need to default
     // to false on Windows.
     const samplingContextsAvailable = process.platform !== 'win32'
-    function checkOptionAllowed (option, description) {
-      if (option && !samplingContextsAvailable) {
+    function checkOptionAllowed (option, description, condition) {
+      if (option && !condition) {
         throw new Error(`${description} not supported on ${process.platform}.`)
       }
     }
+    function checkOptionWithSamplingContextAllowed (option, description) {
+      checkOptionAllowed(option, description, samplingContextsAvailable)
+    }
+
     this.flushInterval = flushInterval
     this.uploadTimeout = uploadTimeout
     this.sourceMap = sourceMap
@@ -109,7 +114,7 @@ class Config {
       DD_PROFILING_ENDPOINT_COLLECTION_ENABLED,
       DD_PROFILING_EXPERIMENTAL_ENDPOINT_COLLECTION_ENABLED, samplingContextsAvailable))
     logExperimentalVarDeprecation('ENDPOINT_COLLECTION_ENABLED')
-    checkOptionAllowed(this.endpointCollectionEnabled, 'Endpoint collection')
+    checkOptionWithSamplingContextAllowed(this.endpointCollectionEnabled, 'Endpoint collection')
 
     this.pprofPrefix = pprofPrefix
     this.v8ProfilerBugWorkaroundEnabled = isTrue(coalesce(options.v8ProfilerBugWorkaround,
@@ -126,8 +131,13 @@ class Config {
       new AgentExporter(this)
     ], this)
 
+    // OOM monitoring does not work well on Windows, so it is disabled by default.
+    const oomMonitoringSupported = process.platform !== 'win32'
+
     const oomMonitoringEnabled = isTrue(coalesce(options.oomMonitoring,
-      DD_PROFILING_EXPERIMENTAL_OOM_MONITORING_ENABLED, true))
+      DD_PROFILING_EXPERIMENTAL_OOM_MONITORING_ENABLED, oomMonitoringSupported))
+    checkOptionAllowed(oomMonitoringEnabled, 'OOM monitoring', oomMonitoringSupported)
+
     const heapLimitExtensionSize = coalesce(options.oomHeapLimitExtensionSize,
       Number(DD_PROFILING_EXPERIMENTAL_OOM_HEAP_LIMIT_EXTENSION_SIZE), 0)
     const maxHeapExtensionCount = coalesce(options.oomMaxHeapExtensionCount,
@@ -154,16 +164,20 @@ class Config {
       })
 
     this.timelineEnabled = isTrue(coalesce(options.timelineEnabled,
+      DD_PROFILING_TIMELINE_ENABLED,
       DD_PROFILING_EXPERIMENTAL_TIMELINE_ENABLED, false))
+    logExperimentalVarDeprecation('TIMELINE_ENABLED')
+    checkOptionWithSamplingContextAllowed(this.timelineEnabled, 'Timeline view')
 
     this.codeHotspotsEnabled = isTrue(coalesce(options.codeHotspotsEnabled,
       DD_PROFILING_CODEHOTSPOTS_ENABLED,
       DD_PROFILING_EXPERIMENTAL_CODEHOTSPOTS_ENABLED, samplingContextsAvailable))
     logExperimentalVarDeprecation('CODEHOTSPOTS_ENABLED')
-    checkOptionAllowed(this.codeHotspotsEnabled, 'Code hotspots')
+    checkOptionWithSamplingContextAllowed(this.codeHotspotsEnabled, 'Code hotspots')
 
     this.cpuProfilingEnabled = isTrue(coalesce(options.cpuProfilingEnabled,
       DD_PROFILING_EXPERIMENTAL_CPU_ENABLED, false))
+    checkOptionWithSamplingContextAllowed(this.cpuProfilingEnabled, 'CPU profiling')
 
     this.profilers = ensureProfilers(profilers, this)
   }

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

@@ -140,8 +140,7 @@ function appStarted (config) {
   return app
 }
 
-function onBeforeExit () {
-  process.removeListener('beforeExit', onBeforeExit)
+function appClosing () {
   const { reqType, payload } = createPayload('app-closing')
   sendData(config, application, host, reqType, payload)
   // we flush before shutting down. Only in CI Visibility
@@ -150,6 +149,11 @@ function onBeforeExit () {
   }
 }
 
+function onBeforeExit () {
+  process.removeListener('beforeExit', onBeforeExit)
+  appClosing()
+}
+
 function createAppObject (config) {
   return {
     service_name: config.service,
@@ -339,5 +343,6 @@ module.exports = {
   start,
   stop,
   updateIntegrations,
-  updateConfig
+  updateConfig,
+  appClosing
 }

package/packages/dd-trace/src/telemetry/send-data.js

@@ -1,6 +1,7 @@
 
 const request = require('../exporters/common/request')
 const log = require('../log')
+const { isTrue } = require('../util')
 
 let agentTelemetry = true
 
@@ -49,13 +50,12 @@ function sendData (config, application, host, reqType, payload = {}, cb = () =>
   const {
     hostname,
     port,
-    experimental,
     isCiVisibility
   } = config
 
   let url = config.url
 
-  const isCiVisibilityAgentlessMode = isCiVisibility && experimental?.exporter === 'datadog'
+  const isCiVisibilityAgentlessMode = isCiVisibility && isTrue(process.env.DD_CIVISIBILITY_AGENTLESS_ENABLED)
 
   if (isCiVisibilityAgentlessMode) {
     try {

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

@@ -135,6 +135,7 @@ class DatadogTracer extends Tracer {
 
   setUrl (url) {
     this._exporter.setUrl(url)
+    this._dataStreamsProcessor.setUrl(url)
   }
 
   scope () {

package/packages/utils/src/kebabcase.js

@@ -0,0 +1,16 @@
+'use strict'
+
+module.exports = str => {
+  if (typeof str !== 'string') {
+    throw new TypeError('Expected a string')
+  }
+
+  return str
+    .trim()
+    .replace(/([a-z])([A-Z])/g, '$1-$2')
+    .replace(/\s+/g, '-')
+    .replace(/^-+|-+$/g, '')
+    .replace(/_/g, '-')
+    .replace(/-{2,}/g, '-')
+    .toLowerCase()
+}

package/packages/utils/src/pick.js

@@ -0,0 +1,11 @@
+'use strict'
+
+module.exports = (object, props) => {
+  const result = {}
+  props.forEach(prop => {
+    if (prop in object) {
+      result[prop] = object[prop]
+    }
+  })
+  return result
+}

package/packages/utils/src/uniq.js

@@ -0,0 +1,5 @@
+'use strict'
+
+module.exports = function (arr) {
+  return [...new Set(arr)]
+}

package/scripts/st.js

@@ -0,0 +1,105 @@
+#!/usr/bin/env node
+/* eslint-disable no-console, no-fallthrough */
+'use strict'
+
+const path = require('path')
+const { writeFileSync } = require('fs')
+const { execSync } = require('child_process')
+
+const ddtracePath = path.join(__dirname, '..')
+const defaultTestPath = process.env.DD_ST_PATH || path.join(ddtracePath, '..', 'system-tests')
+
+const { buildAll, npm, testDir, testArgs } = parseArgs()
+
+const binariesPath = path.join(testDir, 'binaries')
+
+if (npm) {
+  console.log('Using NPM package:', npm)
+
+  writeFileSync(path.join(binariesPath, 'nodejs-load-from-npm'), npm)
+} else {
+  console.log('Using local repo')
+
+  const packName = execSync(`npm pack ${ddtracePath}`, {
+    cwd: binariesPath,
+    stdio: [null, null, 'inherit'],
+    encoding: 'utf8'
+  }).slice(0, -1) // remove trailing newline
+
+  writeFileSync(path.join(binariesPath, 'nodejs-load-from-npm'), `/binaries/${packName}`)
+}
+
+try {
+  execSync(`./build.sh ${buildAll ? '' : '-i weblog'} && ./run.sh ${testArgs}`, {
+    cwd: testDir,
+    stdio: [null, 'inherit', 'inherit']
+  })
+} catch (err) {
+  process.exit(err.status || 1)
+}
+
+function parseArgs () {
+  const args = {
+    buildAll: false,
+    npm: null,
+    testDir: defaultTestPath,
+    testArgs: ''
+  }
+
+  for (let i = 2; i < process.argv.length; i++) {
+    switch (process.argv[i]) {
+      case '-b':
+      case '--build-all':
+        args.buildAll = true
+        break
+
+      case '-h':
+      case '--help':
+        helpAndExit()
+        break
+
+      case '-n':
+      case '--npm': {
+        const arg = process.argv[i + 1]
+        if (!arg || arg[0] === '-') {
+          args.npm = 'dd-trace'
+        } else {
+          args.npm = arg
+          i++
+        }
+        break
+      }
+
+      case '-t':
+      case '--test-dir': {
+        const arg = process.argv[++i]
+        if (!arg || arg[0] === '-') helpAndExit()
+        args.testDir = arg
+        break
+      }
+
+      case '--':
+        args.testArgs = process.argv.slice(i + 1).join(' ')
+        return args
+
+      default:
+        console.log('Unknown option:', process.argv[i], '\n')
+        helpAndExit()
+    }
+  }
+
+  return args
+}
+
+function helpAndExit () {
+  console.log('Usage: node st.js [options...] [-- test-args]')
+  console.log('Options:')
+  console.log('  -b, --build-all       Rebuild all images (default: only build weblog)')
+  console.log('  -h, --help            Print this message')
+  console.log('  -n, --npm [package]   Build a remote package instead of the local repo (default: "dd-trace")')
+  console.log('                        Can be a package name (e.g. "dd-trace@4.2.0") or a git URL (e.g.')
+  console.log('                        "git+https://github.com/DataDog/dd-trace-js.git#mybranch")')
+  console.log('  -t, --test-dir <path> Specify the system-tests directory (default: "dd-trace/../system-tests/")')
+  console.log('  -- <test-args>        Passed to system-tests run.sh (e.g. "-- SCENARIO_NAME tests/path_to_test.py")')
+  process.exit()
+}