dd-trace 3.3.1 → 3.4.0

package/packages/datadog-plugin-pg/src/index.js

@@ -1,65 +1,37 @@
 'use strict'
 
-const Plugin = require('../../dd-trace/src/plugins/plugin')
-const { storage } = require('../../datadog-core')
-const analyticsSampler = require('../../dd-trace/src/analytics_sampler')
-
-class PGPlugin extends Plugin {
-  static get name () {
-    return 'pg'
-  }
-
-  constructor (...args) {
-    super(...args)
-
-    this.addSub(`apm:pg:query:start`, ({ params, statement }) => {
-      const service = getServiceName(this.tracer, this.config, params)
-      const store = storage.getStore()
-      const childOf = store ? store.span : store
-      const span = this.tracer.startSpan('pg.query', {
-        childOf,
-        tags: {
-          'service.name': service,
-          'span.type': 'sql',
-          'span.kind': 'client',
-          'db.type': 'postgres',
-          'resource.name': statement
-        }
-      })
-
-      if (params) {
-        span.addTags({
-          'db.name': params.database,
-          'db.user': params.user,
-          'out.host': params.host,
-          'out.port': params.port
-        })
+const DatabasePlugin = require('../../dd-trace/src/plugins/database')
+
+class PGPlugin extends DatabasePlugin {
+  static get name () { return 'pg' }
+  static get operation () { return 'query' }
+  static get system () { return 'postgres' }
+
+  start ({ params = {}, statement }) {
+    const service = getServiceName(this.config, params)
+
+    this.startSpan('pg.query', {
+      service,
+      resource: statement,
+      type: 'sql',
+      kind: 'client',
+      meta: {
+        'db.type': 'postgres',
+        'db.name': params.database,
+        'db.user': params.user,
+        'out.host': params.host,
+        'out.port': params.port
       }
-
-      analyticsSampler.sample(span, this.config.measured)
-      this.enter(span, store)
-    })
-
-    this.addSub(`apm:pg:query:error`, err => {
-      const span = storage.getStore().span
-      span.setTag('error', err)
-    })
-
-    this.addSub(`apm:pg:query:finish`, () => {
-      const span = storage.getStore().span
-      span.finish()
     })
   }
 }
 
-function getServiceName (tracer, config, params) {
+function getServiceName (config, params) {
   if (typeof config.service === 'function') {
     return config.service(params)
-  } else if (config.service) {
-    return config.service
-  } else {
-    return `${tracer._service}-postgres`
   }
+
+  return config.service
 }
 
 module.exports = PGPlugin

package/packages/datadog-plugin-redis/src/index.js

@@ -1,68 +1,27 @@
 'use strict'
 
-const Plugin = require('../../dd-trace/src/plugins/plugin')
-const { storage } = require('../../datadog-core')
-const analyticsSampler = require('../../dd-trace/src/analytics_sampler')
+const CachePlugin = require('../../dd-trace/src/plugins/cache')
 const urlFilter = require('../../dd-trace/src/plugins/util/urlfilter')
 
-class RedisPlugin extends Plugin {
-  static get name () {
-    return 'redis'
-  }
-
-  constructor (...args) {
-    super(...args)
-
-    this.addSub(`apm:${this.constructor.name}:command:start`, (
-      { db, command, args, connectionOptions, connectionName }
-    ) => {
-      if (!this.config.filter(command)) {
-        return this.skip()
-      }
-      const store = storage.getStore()
-      const childOf = store ? store.span : store
-      const span = this.tracer.startSpan('redis.command', {
-        childOf,
-        tags: {
-          'span.kind': 'client',
-          'resource.name': command,
-          'span.type': 'redis',
-          'db.type': 'redis',
-          'db.name': db || '0',
-          'redis.raw_command': formatCommand(command, args)
-        }
-      })
-
-      span.setTag('service.name', this.config.service || `${span.context()._tags['service.name']}-redis`)
-
-      analyticsSampler.sample(span, this.config.measured)
-
-      if (connectionOptions) {
-        span.addTags({
-          'out.host': connectionOptions.host,
-          'out.port': connectionOptions.port
-        })
+class RedisPlugin extends CachePlugin {
+  static get name () { return 'redis' }
+  static get system () { return 'redis' }
+
+  start ({ db, command, args, connectionOptions = {}, connectionName }) {
+    if (!this.config.filter(command)) return this.skip()
+
+    this.startSpan('redis.command', {
+      service: getService(this.config, connectionName),
+      resource: command,
+      type: 'redis',
+      kind: 'client',
+      meta: {
+        'db.type': 'redis',
+        'db.name': db || '0',
+        'redis.raw_command': formatCommand(command, args),
+        'out.host': connectionOptions.host,
+        'out.port': connectionOptions.port
       }
-
-      if (this.config.splitByInstance && connectionName) {
-        const service = this.config.service
-          ? `${this.config.service}-${connectionName}`
-          : connectionName
-
-        span.setTag('service.name', service)
-      }
-
-      this.enter(span, store)
-    })
-
-    this.addSub(`apm:${this.constructor.name}:command:error`, err => {
-      const span = storage.getStore().span
-      span.setTag('error', err)
-    })
-
-    this.addSub(`apm:${this.constructor.name}:command:finish`, () => {
-      const span = storage.getStore().span
-      span.finish()
     })
   }
 
@@ -71,6 +30,16 @@ class RedisPlugin extends Plugin {
   }
 }
 
+function getService (config, connectionName) {
+  if (config.splitByInstance && connectionName) {
+    return config.service
+      ? `${config.service}-${connectionName}`
+      : connectionName
+  }
+
+  return config.service
+}
+
 function formatCommand (command, args) {
   command = command.toUpperCase()
 

package/packages/datadog-plugin-rhea/src/index.js

@@ -30,11 +30,14 @@ class RheaPlugin extends Plugin {
         }
       })
       analyticsSampler.sample(span, this.config.measured)
-      addDeliveryAnnotations(msg, this.tracer, span)
 
       this.enter(span, store)
     })
 
+    this.addSub('apm:rhea:encode', msg => {
+      addDeliveryAnnotations(msg, this.tracer, this.tracer.scope().active())
+    })
+
     this.addSub(`apm:rhea:receive:start`, ({ msgObj, connection }) => {
       const name = getResourceNameFromMessage(msgObj)
 

package/packages/datadog-plugin-tedious/src/index.js

@@ -1,48 +1,27 @@
 'use strict'
 
-const Plugin = require('../../dd-trace/src/plugins/plugin')
-const { storage } = require('../../datadog-core')
-const analyticsSampler = require('../../dd-trace/src/analytics_sampler')
+const DatabasePlugin = require('../../dd-trace/src/plugins/database')
 
-class TediousPlugin extends Plugin {
-  static get name () {
-    return 'tedious'
-  }
-
-  constructor (...args) {
-    super(...args)
-
-    this.addSub(`apm:tedious:request:start`, ({ queryOrProcedure, connectionConfig }) => {
-      const store = storage.getStore()
-      const childOf = store ? store.span : store
-      const span = this.tracer.startSpan('tedious.request', {
-        childOf,
-        tags: {
-          'span.kind': 'client',
-          'db.type': 'mssql',
-          'span.type': 'sql',
-          'component': 'tedious',
-          'service.name': this.config.service || `${this.tracer._service}-mssql`,
-          'resource.name': queryOrProcedure,
-          'out.host': connectionConfig.server,
-          'out.port': connectionConfig.options.port,
-          'db.user': connectionConfig.userName || connectionConfig.authentication.options.userName,
-          'db.name': connectionConfig.options.database,
-          'db.instance': connectionConfig.options.instanceName
-        }
-      })
-      analyticsSampler.sample(span, this.config.measured)
-      this.enter(span, store)
-    })
-
-    this.addSub(`apm:tedious:request:error`, err => {
-      const span = storage.getStore().span
-      span.setTag('error', err)
-    })
+class TediousPlugin extends DatabasePlugin {
+  static get name () { return 'tedious' }
+  static get operation () { return 'request' } // TODO: change to match other database plugins
+  static get system () { return 'mssql' }
 
-    this.addSub(`apm:tedious:request:finish`, () => {
-      const span = storage.getStore().span
-      span.finish()
+  start ({ queryOrProcedure, connectionConfig }) {
+    this.startSpan('tedious.request', {
+      service: this.config.service,
+      resource: queryOrProcedure,
+      type: 'sql',
+      kind: 'client',
+      meta: {
+        'db.type': 'mssql',
+        'component': 'tedious',
+        'out.host': connectionConfig.server,
+        'out.port': connectionConfig.options.port,
+        'db.user': connectionConfig.userName || connectionConfig.authentication.options.userName,
+        'db.name': connectionConfig.options.database,
+        'db.instance': connectionConfig.options.instanceName
+      }
     })
   }
 }

package/packages/dd-trace/src/ci-visibility/exporters/git/git_metadata.js

@@ -1,9 +1,9 @@
 
 const fs = require('fs')
-const https = require('https')
 const path = require('path')
 
 const FormData = require('../../../exporters/common/form-data')
+const request = require('../../../exporters/common/request')
 
 const log = require('../../../log')
 const {
@@ -18,7 +18,7 @@ const isValidSha = (sha) => /[0-9a-f]{40}/.test(sha)
 function sanitizeCommits (commits) {
   return commits.map(({ id: commitSha, type }) => {
     if (type !== 'commit') {
-      throw new Error('Invalid commit response')
+      throw new Error('Invalid commit type response')
     }
     const sanitizedCommit = commitSha.replace(/[^0-9a-f]+/g, '')
     if (sanitizedCommit !== commitSha || !isValidSha(sanitizedCommit)) {
@@ -71,33 +71,19 @@ function getCommitsToExclude ({ url, repositoryUrl }, callback) {
     }))
   })
 
-  const request = https.request(options, (res) => {
-    let responseData = ''
-
-    res.on('data', chunk => { responseData += chunk })
-    res.on('end', () => {
-      if (res.statusCode === 200) {
-        let commitsToExclude
-        try {
-          commitsToExclude = sanitizeCommits(JSON.parse(responseData).data)
-        } catch (e) {
-          callback(new Error(`Can't parse response: ${e.message}`))
-          return
-        }
-        callback(null, commitsToExclude, headCommit)
-      } else {
-        const error = new Error(`Error getting commits: ${res.statusCode} ${res.statusMessage}`)
-        callback(error)
-      }
-    })
+  request(localCommitData, options, (err, response, statusCode) => {
+    if (err) {
+      const error = new Error(`search_commits returned an error: status code ${statusCode}`)
+      return callback(error)
+    }
+    let commitsToExclude
+    try {
+      commitsToExclude = sanitizeCommits(JSON.parse(response).data)
+    } catch (e) {
+      return callback(new Error(`Can't parse search_commits response: ${e.message}`))
+    }
+    callback(null, commitsToExclude, headCommit)
   })
-
-  request.write(localCommitData)
-  request.on('error', callback)
-
-  request.end()
-
-  return request
 }
 
 /**
@@ -127,7 +113,7 @@ function uploadPackFile ({ url, packFileToUpload, repositoryUrl, headCommit }, c
       contentType: 'application/octet-stream'
     })
   } catch (e) {
-    callback(new Error(`Error reading packfile: ${packFileToUpload}`))
+    callback(new Error(`Could not read "${packFileToUpload}"`))
     return
   }
 
@@ -141,25 +127,13 @@ function uploadPackFile ({ url, packFileToUpload, repositoryUrl, headCommit }, c
       ...form.getHeaders()
     }
   }
-
-  const req = https.request(options, res => {
-    res.on('data', () => {})
-    res.on('end', () => {
-      if (res.statusCode === 204) {
-        callback(null)
-      } else {
-        const error = new Error(`Error uploading packfiles: ${res.statusCode} ${res.statusMessage}`)
-        error.status = res.statusCode
-
-        callback(error)
-      }
-    })
-  })
-
-  req.on('error', err => {
-    callback(err)
+  request(form, options, (err, _, statusCode) => {
+    if (err) {
+      const error = new Error(`Could not upload packfiles: status code ${statusCode}`)
+      return callback(error)
+    }
+    callback(null)
   })
-  form.pipe(req)
 }
 
 /**
@@ -170,27 +144,31 @@ function sendGitMetadata (site, callback) {
 
   const repositoryUrl = getRepositoryUrl()
 
+  if (!repositoryUrl) {
+    return callback(new Error('Repository URL is empty'))
+  }
+
   getCommitsToExclude({ url, repositoryUrl }, (err, commitsToExclude, headCommit) => {
     if (err) {
-      callback(err)
-      return
+      return callback(err)
     }
     const commitsToUpload = getCommitsToUpload(commitsToExclude)
 
     if (!commitsToUpload.length) {
       log.debug('No commits to upload')
-      callback(null)
-      return
+      return callback(null)
     }
-
     const packFilesToUpload = generatePackFilesForCommits(commitsToUpload)
 
+    if (!packFilesToUpload.length) {
+      return callback(new Error('Failed to generate packfiles'))
+    }
+
     let packFileIndex = 0
     // This uploads packfiles sequentially
     const uploadPackFileCallback = (err) => {
       if (err || packFileIndex === packFilesToUpload.length) {
-        callback(err)
-        return
+        return callback(err)
       }
       return uploadPackFile(
         {

package/packages/dd-trace/src/ci-visibility/intelligent-test-runner/get-itr-configuration.js

@@ -0,0 +1,87 @@
+const request = require('../../exporters/common/request')
+const id = require('../../id')
+
+function getItrConfiguration ({
+  site,
+  env,
+  service,
+  repositoryUrl,
+  sha,
+  osVersion,
+  osPlatform,
+  osArchitecture,
+  runtimeName,
+  runtimeVersion,
+  branch
+}, done) {
+  const url = new URL(`https://api.${site}`)
+
+  const apiKey = process.env.DATADOG_API_KEY || process.env.DD_API_KEY
+  const appKey = process.env.DATADOG_APP_KEY ||
+    process.env.DD_APP_KEY ||
+    process.env.DATADOG_APPLICATION_KEY ||
+    process.env.DD_APPLICATION_KEY
+
+  if (!apiKey || !appKey) {
+    done(new Error('App key or API key undefined'))
+    return
+  }
+
+  const options = {
+    path: '/api/v2/libraries/tests/services/setting',
+    method: 'POST',
+    headers: {
+      'dd-api-key': apiKey,
+      'dd-application-key': appKey,
+      'Content-Type': 'application/json'
+    },
+    protocol: url.protocol,
+    hostname: url.hostname,
+    port: url.port
+  }
+
+  const data = JSON.stringify({
+    data: {
+      id: id().toString(10),
+      type: 'ci_app_test_service_libraries_settings',
+      attributes: {
+        test_level: 'suite',
+        configurations: {
+          'os.platform': osPlatform,
+          'os.version': osVersion,
+          'os.architecture': osArchitecture,
+          'runtime.name': runtimeName,
+          'runtime.version': runtimeVersion
+        },
+        service,
+        env,
+        repository_url: repositoryUrl,
+        sha,
+        branch
+      }
+    }
+  })
+
+  request(data, options, (err, res) => {
+    if (err) {
+      done(err)
+    } else {
+      try {
+        const {
+          data: {
+            attributes: {
+              code_coverage: isCodeCoverageEnabled,
+              tests_skipping: isSuitesSkippingEnabled
+            }
+          }
+        } = JSON.parse(res)
+
+        done(null, { isCodeCoverageEnabled, isSuitesSkippingEnabled })
+      } catch (e) {
+        done(e)
+      }
+    }
+  })
+}
+
+module.exports = { getItrConfiguration }

package/packages/dd-trace/src/ci-visibility/intelligent-test-runner/get-skippable-suites.js

@@ -0,0 +1,79 @@
+const request = require('../../exporters/common/request')
+
+function getSkippableSuites ({
+  site,
+  env,
+  service,
+  repositoryUrl,
+  sha,
+  osVersion,
+  osPlatform,
+  osArchitecture,
+  runtimeName,
+  runtimeVersion
+}, done) {
+  const url = new URL(`https://api.${site}`)
+
+  const apiKey = process.env.DATADOG_API_KEY || process.env.DD_API_KEY
+  const appKey = process.env.DATADOG_APP_KEY ||
+    process.env.DD_APP_KEY ||
+    process.env.DATADOG_APPLICATION_KEY ||
+    process.env.DD_APPLICATION_KEY
+
+  if (!apiKey || !appKey) {
+    return done(new Error('API key or Application key are undefined.'))
+  }
+
+  const options = {
+    path: '/api/v2/ci/tests/skippable',
+    method: 'POST',
+    headers: {
+      'dd-api-key': apiKey,
+      'dd-application-key': appKey,
+      'Content-Type': 'application/json'
+    },
+    timeout: 15000,
+    protocol: url.protocol,
+    hostname: url.hostname,
+    port: url.port
+  }
+
+  const data = JSON.stringify({
+    data: {
+      type: 'test_params',
+      attributes: {
+        test_level: 'suite',
+        configurations: {
+          'os.platform': osPlatform,
+          'os.version': osVersion,
+          'os.architecture': osArchitecture,
+          'runtime.name': runtimeName,
+          'runtime.version': runtimeVersion
+        },
+        service,
+        env,
+        repository_url: repositoryUrl,
+        sha
+      }
+    }
+  })
+
+  request(data, options, (err, res) => {
+    if (err) {
+      done(err)
+    } else {
+      let skippableSuites = []
+      try {
+        skippableSuites = JSON.parse(res)
+          .data
+          .filter(({ type }) => type === 'suite')
+          .map(({ attributes: { suite } }) => suite)
+        done(null, skippableSuites)
+      } catch (e) {
+        done(e)
+      }
+    }
+  })
+}
+
+module.exports = { getSkippableSuites }

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

@@ -12,7 +12,6 @@ const MAXIMUM_NUM_COVERAGE_FILES = 100
 class CoverageCIVisibilityEncoder extends AgentEncoder {
   constructor () {
     super(...arguments)
-    this.codeCoverageBuffers = []
     this._coverageBytes = new Chunk()
     this.form = new FormData()
     this.fileIndex = 1

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

@@ -123,6 +123,7 @@ module.exports = class PluginManager {
       clientIpHeaderDisabled,
       clientIpHeader,
       isIntelligentTestRunnerEnabled,
+      site,
       experimental
     } = this._tracerConfig
 
@@ -154,6 +155,8 @@ module.exports = class PluginManager {
       sharedConfig.service = serviceMapping[name]
     }
 
+    sharedConfig.site = site
+
     return sharedConfig
   }
 }

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

@@ -0,0 +1,9 @@
+'use strict'
+
+const StoragePlugin = require('./storage')
+
+class CachePlugin extends StoragePlugin {
+  static get operation () { return 'command' }
+}
+
+module.exports = CachePlugin

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

@@ -0,0 +1,7 @@
+'use strict'
+
+const OutgoingPlugin = require('./outgoing')
+
+class ClientPlugin extends OutgoingPlugin {}
+
+module.exports = ClientPlugin

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

@@ -0,0 +1,9 @@
+'use strict'
+
+const StoragePlugin = require('./storage')
+
+class DatabasePlugin extends StoragePlugin {
+  static get operation () { return 'query' }
+}
+
+module.exports = DatabasePlugin

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

@@ -10,6 +10,7 @@ module.exports = {
   get '@jest/core' () { return require('../../../datadog-plugin-jest/src') },
   get '@koa/router' () { return require('../../../datadog-plugin-koa/src') },
   get '@node-redis/client' () { return require('../../../datadog-plugin-redis/src') },
+  get '@redis/client' () { return require('../../../datadog-plugin-redis/src') },
   get 'amqp10' () { return require('../../../datadog-plugin-amqp10/src') },
   get 'amqplib' () { return require('../../../datadog-plugin-amqplib/src') },
   get 'aws-sdk' () { return require('../../../datadog-plugin-aws-sdk/src') },
@@ -38,6 +39,7 @@ module.exports = {
   get 'koa' () { return require('../../../datadog-plugin-koa/src') },
   get 'koa-router' () { return require('../../../datadog-plugin-koa/src') },
   get 'kafkajs' () { return require('../../../datadog-plugin-kafkajs/src') },
+  get 'mariadb' () { return require('../../../datadog-plugin-mariadb/src') },
   get 'memcached' () { return require('../../../datadog-plugin-memcached/src') },
   get 'microgateway-core' () { return require('../../../datadog-plugin-microgateway-core/src') },
   get 'mocha' () { return require('../../../datadog-plugin-mocha/src') },