dd-trace 3.3.1 → 3.4.0

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

@@ -0,0 +1,31 @@
+'use strict'
+
+const TracingPlugin = require('./tracing')
+
+// TODO: Exit span on finish when AsyncResource instances are removed.
+class OutgoingPlugin extends TracingPlugin {
+  constructor (...args) {
+    super(...args)
+
+    this.addTraceSub('connect', message => {
+      this.connect(message)
+    })
+  }
+
+  connect (url) {
+    this.addHost(url.hostname, url.port)
+  }
+
+  addHost (hostname, port) {
+    const span = this.activeSpan()
+
+    if (!span) return
+
+    span.addTags({
+      'out.host': hostname,
+      'out.port': port
+    })
+  }
+}
+
+module.exports = OutgoingPlugin

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

@@ -1,5 +1,7 @@
 'use strict'
 
+// TODO: move anything related to tracing to TracingPlugin instead
+
 const dc = require('diagnostics_channel')
 const { storage } = require('../../../datadog-core')
 
@@ -39,6 +41,7 @@ module.exports = class Plugin {
     storage.enterWith({ ...store, span })
   }
 
+  // TODO: Implement filters on resource name for all plugins.
   /** Prevents creation of spans here and for all async descendants. */
   skip () {
     storage.enterWith({ noop: true })

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

@@ -0,0 +1,25 @@
+'use strict'
+
+const ClientPlugin = require('./client')
+
+class StoragePlugin extends ClientPlugin {
+  constructor (...args) {
+    super(...args)
+
+    this.system = this.constructor.system || this.component
+
+    this.addTraceSub('connect', message => {
+      this.connect(message)
+    })
+  }
+
+  startSpan (name, options) {
+    if (!options.service && this.system) {
+      options.service = `${this.tracer._service}-${this.system}`
+    }
+
+    return super.startSpan(name, options)
+  }
+}
+
+module.exports = StoragePlugin

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

@@ -0,0 +1,91 @@
+'use strict'
+
+const Plugin = require('./plugin')
+const { storage } = require('../../../datadog-core')
+const analyticsSampler = require('../analytics_sampler')
+
+class TracingPlugin extends Plugin {
+  constructor (...args) {
+    super(...args)
+
+    this.component = this.constructor.component || this.constructor.name
+    this.operation = this.constructor.operation
+
+    this.addTraceSub('start', message => {
+      this.start(message)
+    })
+
+    this.addTraceSub('error', err => {
+      this.error(err)
+    })
+
+    this.addTraceSub('finish', message => {
+      this.finish(message)
+    })
+  }
+
+  configure (config) {
+    return super.configure({
+      ...config,
+      hooks: {
+        [this.operation]: () => {},
+        ...config.hooks
+      }
+    })
+  }
+
+  start () {} // implemented by individual plugins
+
+  finish () {
+    this.activeSpan().finish()
+  }
+
+  error (error) {
+    this.addError(error)
+  }
+
+  addTraceSub (eventName, handler) {
+    this.addSub(`apm:${this.component}:${this.operation}:${eventName}`, handler)
+  }
+
+  addError (error) {
+    const span = this.activeSpan()
+
+    if (!span._spanContext._tags['error']) {
+      span.setTag('error', error || 1)
+    }
+  }
+
+  startSpan (name, { childOf, kind, meta, metrics, service, resource, type } = {}) {
+    const store = storage.getStore()
+
+    if (store && childOf === undefined) {
+      childOf = store.span
+    }
+
+    const span = this.tracer.startSpan(name, {
+      tags: {
+        'service.name': service,
+        'resource.name': resource,
+        'span.kind': kind,
+        'span.type': type,
+        ...meta,
+        ...metrics
+      }
+    })
+
+    analyticsSampler.sample(span, this.config.measured)
+
+    storage.enterWith({ ...store, span })
+
+    return span
+  }
+
+  activeSpan () {
+    const store = storage.getStore()
+
+    return store && store.span
+  }
+}
+
+module.exports = TracingPlugin

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

@@ -1,6 +1,8 @@
 const { execSync } = require('child_process')
 const os = require('os')
+const path = require('path')
 
+const log = require('../../log')
 const { sanitizedExec } = require('./exec')
 const {
   GIT_COMMIT_SHA,
@@ -17,15 +19,22 @@ const {
   CI_WORKSPACE_PATH
 } = require('./tags')
 
+const GIT_REV_LIST_MAX_BUFFER = 8 * 1024 * 1024 // 8MB
+
 function getRepositoryUrl () {
   return sanitizedExec('git config --get remote.origin.url', { stdio: 'pipe' })
 }
 
 function getLatestCommits () {
-  return execSync('git log --format=%H -n 1000 --since="1 month ago"', { stdio: 'pipe' })
-    .toString()
-    .split('\n')
-    .filter(commit => !!commit)
+  try {
+    return execSync('git log --format=%H -n 1000 --since="1 month ago"', { stdio: 'pipe' })
+      .toString()
+      .split('\n')
+      .filter(commit => commit)
+  } catch (err) {
+    log.error(err)
+    return []
+  }
 }
 
 function getCommitsToUpload (commitsToExclude) {
@@ -36,27 +45,57 @@ function getCommitsToUpload (commitsToExclude) {
     gitCommandToGetCommitsToUpload = `${gitCommandToGetCommitsToUpload} ^${commit}`
   })
 
-  return execSync(gitCommandToGetCommitsToUpload, { stdio: 'pipe' })
-    .toString()
-    .split('\n')
-    .filter(commit => !!commit)
+  try {
+    return execSync(gitCommandToGetCommitsToUpload, { stdio: 'pipe', maxBuffer: GIT_REV_LIST_MAX_BUFFER })
+      .toString()
+      .split('\n')
+      .filter(commit => commit)
+  } catch (err) {
+    log.error(err)
+    return []
+  }
 }
 
-// Generates pack files to upload and
-// returns the ordered list of packfiles' paths
 function generatePackFilesForCommits (commitsToUpload) {
   const tmpFolder = os.tmpdir()
 
-  const prefix = Math.floor(Math.random() * 10000)
-  const path = `${tmpFolder}/${prefix}`
+  const randomPrefix = String(Math.floor(Math.random() * 10000))
+  const temporaryPath = path.join(tmpFolder, randomPrefix)
+  const cwdPath = path.join(process.cwd(), randomPrefix)
 
-  const orderedCommits =
-    execSync(
-      `git pack-objects --compression=9 --max-pack-size=3m ${path}`,
+  // Generates pack files to upload and
+  // returns the ordered list of packfiles' paths
+  function execGitPackObjects (targetPath) {
+    return execSync(
+      `git pack-objects --compression=9 --max-pack-size=3m ${targetPath}`,
       { input: commitsToUpload.join('\n') }
-    ).toString().split('\n').filter(commit => !!commit)
+    ).toString().split('\n').filter(commit => commit).map(commit => `${targetPath}-${commit}.pack`)
+  }
+
+  try {
+    return execGitPackObjects(temporaryPath, commitsToUpload)
+  } catch (err) {
+    log.error(err)
+    /**
+     * The generation of pack files in the temporary folder (from `os.tmpdir()`)
+     * sometimes fails in certain CI setups with the error message
+     * `unable to rename temporary pack file: Invalid cross-device link`.
+     * The reason why is unclear.
+     *
+     * A workaround is to attempt to generate the pack files in `process.cwd()`.
+     * While this works most of the times, it's not ideal since it affects the git status.
+     * This workaround is intended to be temporary.
+     *
+     * TODO: fix issue and remove workaround.
+     */
+    try {
+      return execGitPackObjects(cwdPath, commitsToUpload)
+    } catch (err) {
+      log.error(err)
+    }
 
-  return orderedCommits.map(commit => `${path}-${commit}.pack`)
+    return []
+  }
 }
 
 // If there is ciMetadata, it takes precedence.
@@ -106,5 +145,6 @@ module.exports = {
   getLatestCommits,
   getRepositoryUrl,
   generatePackFilesForCommits,
-  getCommitsToUpload
+  getCommitsToUpload,
+  GIT_REV_LIST_MAX_BUFFER
 }

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

@@ -48,6 +48,10 @@ const CI_APP_ORIGIN = 'ciapp-test'
 
 const JEST_TEST_RUNNER = 'test.jest.test_runner'
 
+const TEST_ITR_TESTS_SKIPPED = '_dd.ci.itr.tests_skipped'
+
+const TEST_CODE_COVERAGE_LINES_TOTAL = 'test.codecov_lines_total'
+
 module.exports = {
   TEST_CODE_OWNERS,
   TEST_FRAMEWORK,
@@ -78,7 +82,9 @@ module.exports = {
   getTestSuiteCommonTags,
   TEST_COMMAND,
   TEST_SESSION_ID,
-  TEST_SUITE_ID
+  TEST_SUITE_ID,
+  TEST_ITR_TESTS_SKIPPED,
+  TEST_CODE_COVERAGE_LINES_TOTAL
 }
 
 function getTestEnvironmentMetadata (testFramework, config) {

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

@@ -1,4 +1,5 @@
 'use strict'
+const { channel } = require('diagnostics_channel')
 
 const NoopProxy = require('./noop/proxy')
 const DatadogTracer = require('./tracer')
@@ -10,6 +11,8 @@ const telemetry = require('./telemetry')
 const PluginManager = require('./plugin_manager')
 const { sendGitMetadata } = require('./ci-visibility/exporters/git/git_metadata')
 
+const gitMetadataUploadFinishCh = channel('ci:git-metadata-upload:finish')
+
 class Tracer extends NoopProxy {
   constructor () {
     super()
@@ -65,6 +68,7 @@ class Tracer extends NoopProxy {
           } else {
             log.debug('Successfully uploaded git metadata')
           }
+          gitMetadataUploadFinishCh.publish(err)
         })
       }
     } catch (e) {

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

@@ -6,6 +6,10 @@ const os = require('os')
 const dependencies = require('./dependencies')
 const { sendData } = require('./send-data')
 
+const HEARTBEAT_INTERVAL = process.env.DD_TELEMETRY_HEARTBEAT_INTERVAL
+  ? Number(process.env.DD_TELEMETRY_HEARTBEAT_INTERVAL) * 1000
+  : 60000
+
 let config
 let pluginManager
 
@@ -88,7 +92,9 @@ function start (aConfig, thePluginManager) {
   host = createHostObject()
   dependencies.start(config, application, host)
   sendData(config, application, host, 'app-started', appStarted())
-  interval = setInterval(() => sendData(config, application, host, 'app-heartbeat'), 60000)
+  interval = setInterval(() => {
+    sendData(config, application, host, 'app-heartbeat')
+  }, HEARTBEAT_INTERVAL)
   interval.unref()
   process.on('beforeExit', onBeforeExit)
 }