dd-trace 2.25.0 → 2.26.0

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

@@ -2,6 +2,7 @@
 
 module.exports = {
   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') },

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

@@ -122,7 +122,7 @@ module.exports = {
         [CI_ENV_VARS]: JSON.stringify({ DD_CUSTOM_TRACE_ID })
       }
 
-      const isTag = JENKINS_GIT_BRANCH && JENKINS_GIT_BRANCH.includes('tags')
+      const isTag = JENKINS_GIT_BRANCH && JENKINS_GIT_BRANCH.includes('tags/')
       const refKey = isTag ? GIT_TAG : GIT_BRANCH
       const ref = normalizeRef(JENKINS_GIT_BRANCH)
 
@@ -216,7 +216,8 @@ module.exports = {
         [GIT_REPOSITORY_URL]: CIRCLE_REPOSITORY_URL,
         [CI_JOB_URL]: CIRCLE_BUILD_URL,
         [CI_WORKSPACE_PATH]: CIRCLE_WORKING_DIRECTORY,
-        [CIRCLE_TAG ? GIT_TAG : GIT_BRANCH]: CIRCLE_TAG || CIRCLE_BRANCH,
+        [GIT_TAG]: CIRCLE_TAG,
+        [GIT_BRANCH]: CIRCLE_BRANCH,
         [CI_ENV_VARS]: JSON.stringify({
           CIRCLE_WORKFLOW_ID,
           CIRCLE_BUILD_NUM
@@ -249,7 +250,7 @@ module.exports = {
       const jobUrl = `${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/commit/${GITHUB_SHA}/checks`
 
       const ref = GITHUB_HEAD_REF || GITHUB_REF || ''
-      const refKey = ref.includes('tags') ? GIT_TAG : GIT_BRANCH
+      const refKey = ref.includes('tags/') ? GIT_TAG : GIT_BRANCH
 
       tags = {
         [CI_PIPELINE_ID]: GITHUB_RUN_ID,
@@ -305,13 +306,12 @@ module.exports = {
       }
 
       if (APPVEYOR_REPO_PROVIDER === 'github') {
-        const refKey = APPVEYOR_REPO_TAG_NAME ? GIT_TAG : GIT_BRANCH
-        const ref = APPVEYOR_REPO_TAG_NAME || APPVEYOR_PULL_REQUEST_HEAD_REPO_BRANCH || APPVEYOR_REPO_BRANCH
         tags = {
           ...tags,
           [GIT_REPOSITORY_URL]: `https://github.com/${APPVEYOR_REPO_NAME}.git`,
           [GIT_COMMIT_SHA]: APPVEYOR_REPO_COMMIT,
-          [refKey]: ref
+          [GIT_TAG]: APPVEYOR_REPO_TAG_NAME,
+          [GIT_BRANCH]: APPVEYOR_PULL_REQUEST_HEAD_REPO_BRANCH || APPVEYOR_REPO_BRANCH
         }
       }
     }
@@ -340,7 +340,7 @@ module.exports = {
       } = env
 
       const ref = SYSTEM_PULLREQUEST_SOURCEBRANCH || BUILD_SOURCEBRANCH || BUILD_SOURCEBRANCHNAME
-      const refKey = (ref || '').includes('tags') ? GIT_TAG : GIT_BRANCH
+      const refKey = (ref || '').includes('tags/') ? GIT_TAG : GIT_BRANCH
 
       tags = {
         [CI_PROVIDER_NAME]: 'azurepipelines',
@@ -419,10 +419,6 @@ module.exports = {
         BITRISE_GIT_MESSAGE
       } = env
 
-      const isTag = !!BITRISE_GIT_TAG
-      const refKey = isTag ? GIT_TAG : GIT_BRANCH
-      const ref = BITRISE_GIT_TAG || BITRISEIO_GIT_BRANCH_DEST || BITRISE_GIT_BRANCH
-
       tags = {
         [CI_PROVIDER_NAME]: 'bitrise',
         [CI_PIPELINE_ID]: BITRISE_BUILD_SLUG,
@@ -432,7 +428,8 @@ module.exports = {
         [GIT_COMMIT_SHA]: BITRISE_GIT_COMMIT || GIT_CLONE_COMMIT_HASH,
         [GIT_REPOSITORY_URL]: BITRISE_GIT_REPOSITORY_URL,
         [CI_WORKSPACE_PATH]: BITRISE_SOURCE_DIR,
-        [refKey]: ref,
+        [GIT_TAG]: BITRISE_GIT_TAG,
+        [GIT_BRANCH]: BITRISEIO_GIT_BRANCH_DEST || BITRISE_GIT_BRANCH,
         [GIT_COMMIT_MESSAGE]: BITRISE_GIT_MESSAGE
       }
     }
@@ -454,9 +451,6 @@ module.exports = {
         BUILDKITE_MESSAGE
       } = env
 
-      const ref = BUILDKITE_TAG || BUILDKITE_BRANCH
-      const refKey = BUILDKITE_TAG ? GIT_TAG : GIT_BRANCH
-
       tags = {
         [CI_PROVIDER_NAME]: 'buildkite',
         [CI_PIPELINE_ID]: BUILDKITE_BUILD_ID,
@@ -467,7 +461,8 @@ module.exports = {
         [GIT_COMMIT_SHA]: BUILDKITE_COMMIT,
         [CI_WORKSPACE_PATH]: BUILDKITE_BUILD_CHECKOUT_PATH,
         [GIT_REPOSITORY_URL]: BUILDKITE_REPO,
-        [refKey]: ref,
+        [GIT_TAG]: BUILDKITE_TAG,
+        [GIT_BRANCH]: BUILDKITE_BRANCH,
         [GIT_COMMIT_AUTHOR_NAME]: BUILDKITE_BUILD_AUTHOR,
         [GIT_COMMIT_AUTHOR_EMAIL]: BUILDKITE_BUILD_AUTHOR_EMAIL,
         [GIT_COMMIT_MESSAGE]: BUILDKITE_MESSAGE,
@@ -493,10 +488,6 @@ module.exports = {
         TRAVIS_COMMIT_MESSAGE
       } = env
 
-      const isTag = !!TRAVIS_TAG
-      const ref = TRAVIS_TAG || TRAVIS_PULL_REQUEST_BRANCH || TRAVIS_BRANCH
-      const refKey = isTag ? GIT_TAG : GIT_BRANCH
-
       tags = {
         [CI_PROVIDER_NAME]: 'travisci',
         [CI_JOB_URL]: TRAVIS_JOB_WEB_URL,
@@ -507,7 +498,8 @@ module.exports = {
         [GIT_COMMIT_SHA]: TRAVIS_COMMIT,
         [GIT_REPOSITORY_URL]: `https://github.com/${TRAVIS_REPO_SLUG}.git`,
         [CI_WORKSPACE_PATH]: TRAVIS_BUILD_DIR,
-        [refKey]: ref,
+        [GIT_TAG]: TRAVIS_TAG,
+        [GIT_BRANCH]: TRAVIS_PULL_REQUEST_BRANCH || TRAVIS_BRANCH,
         [GIT_COMMIT_MESSAGE]: TRAVIS_COMMIT_MESSAGE
       }
     }

package/packages/dd-trace/src/{appsec → plugins/util}/ip_extractor.js

@@ -2,7 +2,7 @@
 
 const BlockList = require('./ip_blocklist')
 const net = require('net')
-const log = require('../log')
+const log = require('../../log')
 
 const ipHeaderList = [
   'x-forwarded-for',

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

@@ -38,7 +38,9 @@ const TEST_CODE_OWNERS = 'test.codeowners'
 const TEST_SOURCE_FILE = 'test.source.file'
 const LIBRARY_VERSION = 'library_version'
 const TEST_COMMAND = 'test.command'
+const TEST_BUNDLE = 'test.bundle'
 const TEST_SESSION_ID = 'test_session_id'
+const TEST_MODULE_ID = 'test_module_id'
 const TEST_SUITE_ID = 'test_suite_id'
 
 const CI_APP_ORIGIN = 'ciapp-test'
@@ -75,9 +77,11 @@ module.exports = {
   getCodeOwnersForFilename,
   getTestCommonTags,
   getTestSessionCommonTags,
+  getTestModuleCommonTags,
   getTestSuiteCommonTags,
   TEST_COMMAND,
   TEST_SESSION_ID,
+  TEST_MODULE_ID,
   TEST_SUITE_ID,
   TEST_ITR_TESTS_SKIPPED,
   TEST_SESSION_ITR_SKIPPING_ENABLED,
@@ -242,26 +246,39 @@ function getCodeOwnersForFilename (filename, entries) {
   return null
 }
 
-function getTestSessionCommonTags (command, version) {
+function getTestLevelCommonTags (command, testFrameworkVersion) {
+  return {
+    [TEST_FRAMEWORK_VERSION]: testFrameworkVersion,
+    [LIBRARY_VERSION]: ddTraceVersion,
+    [TEST_COMMAND]: command,
+    [TEST_TYPE]: 'test'
+  }
+}
+
+function getTestSessionCommonTags (command, testFrameworkVersion) {
   return {
     [SPAN_TYPE]: 'test_session_end',
-    [TEST_TYPE]: 'test',
     [RESOURCE_NAME]: `test_session.${command}`,
-    [TEST_FRAMEWORK_VERSION]: version,
-    [LIBRARY_VERSION]: ddTraceVersion,
-    [TEST_COMMAND]: command
+    ...getTestLevelCommonTags(command, testFrameworkVersion)
   }
 }
 
-function getTestSuiteCommonTags (command, version, testSuite) {
+function getTestModuleCommonTags (command, testFrameworkVersion) {
+  return {
+    [SPAN_TYPE]: 'test_module_end',
+    [RESOURCE_NAME]: `test_module.${command}`,
+    [TEST_BUNDLE]: command,
+    ...getTestLevelCommonTags(command, testFrameworkVersion)
+  }
+}
+
+function getTestSuiteCommonTags (command, testFrameworkVersion, testSuite) {
   return {
     [SPAN_TYPE]: 'test_suite_end',
-    [TEST_TYPE]: 'test',
     [RESOURCE_NAME]: `test_suite.${testSuite}`,
-    [TEST_FRAMEWORK_VERSION]: version,
-    [LIBRARY_VERSION]: ddTraceVersion,
+    [TEST_BUNDLE]: command,
     [TEST_SUITE]: testSuite,
-    [TEST_COMMAND]: command
+    ...getTestLevelCommonTags(command, testFrameworkVersion)
   }
 }
 

package/packages/dd-trace/src/plugins/util/user-provided-git.js

@@ -54,16 +54,11 @@ function getUserProviderGitMetadata () {
     DD_GIT_COMMIT_AUTHOR_DATE
   } = process.env
 
-  let branch = normalizeRef(DD_GIT_BRANCH)
+  const branch = normalizeRef(DD_GIT_BRANCH)
   let tag = normalizeRef(DD_GIT_TAG)
 
-  if (DD_GIT_TAG) {
-    branch = undefined
-  }
-
-  // if DD_GIT_BRANCH is a tag, we associate its value to TAG instead of BRANCH
+  // if DD_GIT_BRANCH is a tag, we associate its value to TAG too
   if ((DD_GIT_BRANCH || '').includes('origin/tags') || (DD_GIT_BRANCH || '').includes('refs/heads/tags')) {
-    branch = undefined
     tag = normalizeRef(DD_GIT_BRANCH)
   }
 

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

@@ -8,6 +8,7 @@ const tags = require('../../../../../ext/tags')
 const types = require('../../../../../ext/types')
 const kinds = require('../../../../../ext/kinds')
 const urlFilter = require('./urlfilter')
+const { extractIp } = require('./ip_extractor')
 const { ERROR_MESSAGE, ERROR_TYPE, ERROR_STACK } = require('../../constants')
 
 const WEB = types.WEB
@@ -24,6 +25,7 @@ const HTTP_ROUTE = tags.HTTP_ROUTE
 const HTTP_REQUEST_HEADERS = tags.HTTP_REQUEST_HEADERS
 const HTTP_RESPONSE_HEADERS = tags.HTTP_RESPONSE_HEADERS
 const HTTP_USERAGENT = tags.HTTP_USERAGENT
+const HTTP_CLIENT_IP = tags.HTTP_CLIENT_IP
 const MANUAL_DROP = tags.MANUAL_DROP
 
 const HTTP2_HEADER_AUTHORITY = ':authority'
@@ -432,6 +434,15 @@ function addRequestTags (context) {
     [HTTP_USERAGENT]: req.headers['user-agent']
   })
 
+  // if client ip has already been set by appsec, no need to run it again
+  if (config.clientIpEnabled && !span.context()._tags.hasOwnProperty(HTTP_CLIENT_IP)) {
+    const clientIp = extractIp(config, req)
+
+    if (clientIp) {
+      span.setTag(HTTP_CLIENT_IP, clientIp)
+    }
+  }
+
   addHeaders(context)
 }
 

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

@@ -8,6 +8,7 @@ const log = require('./log')
 const { setStartupLogPluginManager } = require('./startup-log')
 const telemetry = require('./telemetry')
 const remoteConfig = require('./appsec/remote_config')
+const AppsecSdk = require('./appsec/sdk')
 
 class Tracer extends NoopProxy {
   constructor () {
@@ -50,6 +51,7 @@ class Tracer extends NoopProxy {
         }
 
         this._tracer = new DatadogTracer(config)
+        this.appsec = new AppsecSdk(this._tracer)
 
         if (config.iast.enabled) {
           require('./appsec/iast').enable(config, this._tracer)

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

@@ -7,7 +7,7 @@ const { inspect } = require('util')
 const tracerVersion = require('../../../package.json').version
 
 const logger = Object.create(mainLogger)
-logger._enabled = true
+logger.toggle(true)
 
 let config
 let pluginManager

package/scripts/check-proposal-labels.js

@@ -0,0 +1,71 @@
+/* eslint-disable no-console */
+
+const childProcess = require('child_process')
+const ORIGIN = 'origin/'
+
+let releaseBranch = process.env['GITHUB_BASE_REF'] // 'origin/v3.x'
+let releaseVersion = releaseBranch
+if (releaseBranch.startsWith(ORIGIN)) {
+  releaseVersion = releaseBranch.substring(ORIGIN.length)
+} else {
+  releaseBranch = ORIGIN + releaseBranch
+}
+let currentBranch = process.env['GITHUB_HEAD_REF'] // 'ugaitz/workflow-to-verify-dont-land-on-v3.x'
+if (!currentBranch.startsWith(ORIGIN)) {
+  currentBranch = ORIGIN + currentBranch
+}
+
+const getHashesCommandWithExclusions = 'branch-diff --user DataDog --repo dd-trace-js --exclude-label=semver-major' +
+  ` --exclude-label=dont-land-on-${releaseVersion} ${releaseBranch} ${currentBranch}`
+const getHashesCommandWithoutExclusions =
+  `branch-diff --user DataDog --repo dd-trace-js ${releaseBranch} ${currentBranch}`
+
+childProcess.exec(getHashesCommandWithExclusions, { timeout: 30000 },
+  (withExclusionError, withExclusionStdout, withExclusionStderr) => {
+    if (withExclusionError) {
+      console.error(`stdout:
+${withExclusionStdout}
+stderr:
+${withExclusionStderr}
+`, withExclusionError)
+      process.exit(1)
+      return
+    }
+    if (withExclusionStderr) {
+      console.error(withExclusionStderr)
+      process.exit(1)
+      return
+    }
+    const commitsHashesWithExclusions = withExclusionStdout.split('\n')
+
+    childProcess.exec(getHashesCommandWithoutExclusions,
+      (withoutExclusionError, withoutExclusionStdout, withoutExclusionStderr) => {
+        if (withoutExclusionError) {
+          console.error(`stdout:
+${withoutExclusionStdout}
+stderr:
+${withoutExclusionStderr}
+`, withoutExclusionError)
+          process.exit(1)
+          return
+        }
+        if (withoutExclusionStderr) {
+          console.error(withoutExclusionStderr)
+          process.exit(1)
+          return
+        }
+        const commitsHashesWithoutExclusions = withoutExclusionStdout.split('\n')
+        if (commitsHashesWithExclusions.length !== commitsHashesWithoutExclusions.length) {
+          const commitsWithInvalidLabels = []
+          commitsHashesWithoutExclusions.filter(c1 => {
+            if (!commitsHashesWithExclusions.some(c2 => c2 === c1)) {
+              commitsWithInvalidLabels.push(c1)
+            }
+          })
+          console.error('Some excluded label added in the release proposal', commitsWithInvalidLabels)
+          process.exit(1)
+        } else {
+          console.log('Commit PRs label looks OK')
+        }
+      })
+  })

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

@@ -1,143 +0,0 @@
-'use strict'
-
-const { storage } = require('../../datadog-core')
-
-const _default = {
-  debug: msg => console.debug(msg), /* eslint-disable-line no-console */
-  info: msg => console.info(msg), /* eslint-disable-line no-console */
-  warn: msg => console.warn(msg), /* eslint-disable-line no-console */
-  error: msg => console.error(msg) /* eslint-disable-line no-console */
-}
-
-// based on: https://github.com/trentm/node-bunyan#levels
-const _logLevels = {
-  'debug': 20,
-  'info': 30,
-  'warn': 40,
-  'error': 50
-}
-
-const _defaultLogLevel = 'debug'
-
-const _checkLogLevel = (logLevel) => {
-  if (logLevel && typeof logLevel === 'string') {
-    return _logLevels[logLevel.toLowerCase().trim()] || _logLevels[_defaultLogLevel]
-  }
-
-  return _logLevels[_defaultLogLevel]
-}
-
-const memoize = func => {
-  const cache = {}
-  const memoized = function (key) {
-    if (!cache[key]) {
-      cache[key] = func.apply(this, arguments)
-    }
-
-    return cache[key]
-  }
-
-  return memoized
-}
-
-function processMsg (msg) {
-  return typeof msg === 'function' ? msg() : msg
-}
-
-function withNoop (fn) {
-  const store = storage.getStore()
-
-  storage.enterWith({ noop: true })
-  fn()
-  storage.enterWith(store)
-}
-
-const log = {
-  _isLogLevelEnabled (level) {
-    return _logLevels[level] >= this._logLevel
-  },
-
-  use (logger) {
-    if (logger && logger.debug instanceof Function && logger.error instanceof Function) {
-      this._logger = logger
-    }
-
-    return this
-  },
-
-  toggle (enabled, logLevel, tracer) {
-    this._enabled = enabled
-    this._logLevel = _checkLogLevel(logLevel)
-    this._tracer = tracer
-
-    return this
-  },
-
-  reset () {
-    this._logger = _default
-    this._enabled = false
-    this._deprecate = memoize((code, message) => {
-      withNoop(() => this._logger.error(message))
-      return this
-    })
-    this._logLevel = _checkLogLevel()
-
-    return this
-  },
-
-  debug (message) {
-    if (this._enabled && this._isLogLevelEnabled('debug')) {
-      withNoop(() => this._logger.debug(processMsg(message)))
-    }
-
-    return this
-  },
-
-  info (message) {
-    if (!this._logger.info) return this.debug(message)
-    if (this._enabled && this._isLogLevelEnabled('info')) {
-      withNoop(() => this._logger.info(processMsg(message)))
-    }
-
-    return this
-  },
-
-  warn (message) {
-    if (!this._logger.warn) return this.debug(message)
-    if (this._enabled && this._isLogLevelEnabled('warn')) {
-      withNoop(() => this._logger.warn(processMsg(message)))
-    }
-
-    return this
-  },
-
-  error (err) {
-    if (this._enabled && this._isLogLevelEnabled('error')) {
-      if (err instanceof Function) {
-        err = err()
-      }
-
-      if (typeof err !== 'object' || !err) {
-        err = String(err)
-      } else if (!err.stack) {
-        err = String(err.message || err)
-      }
-
-      if (typeof err === 'string') {
-        err = new Error(err)
-      }
-
-      withNoop(() => this._logger.error(err))
-    }
-
-    return this
-  },
-
-  deprecate (code, message) {
-    return this._deprecate(code, message)
-  }
-}
-
-log.reset()
-
-module.exports = log