dd-trace 4.47.0 → 4.48.0

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

@@ -137,7 +137,8 @@ module.exports = class PluginManager {
       dsmEnabled,
       clientIpEnabled,
       memcachedCommandEnabled,
-      ciVisibilityTestSessionName
+      ciVisibilityTestSessionName,
+      ciVisAgentlessLogSubmissionEnabled
     } = this._tracerConfig
 
     const sharedConfig = {
@@ -147,7 +148,8 @@ module.exports = class PluginManager {
       site,
       url,
       headers: headerTags || [],
-      ciVisibilityTestSessionName
+      ciVisibilityTestSessionName,
+      ciVisAgentlessLogSubmissionEnabled
     }
 
     if (logInjection !== undefined) {

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

@@ -100,7 +100,9 @@ module.exports = class CiPlugin extends Plugin {
           ...testSessionSpanMetadata
         }
       })
+      // TODO: add telemetry tag when we can add `is_agentless_log_submission_enabled` for agentless log submission
       this.telemetry.ciVisEvent(TELEMETRY_EVENT_CREATED, 'session')
+
       this.testModuleSpan = this.tracer.startSpan(`${this.constructor.id}.test_module`, {
         childOf: this.testSessionSpan,
         tags: {

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

@@ -3,6 +3,7 @@
 module.exports = {
   get '@apollo/gateway' () { return require('../../../datadog-plugin-apollo/src') },
   get '@aws-sdk/smithy-client' () { return require('../../../datadog-plugin-aws-sdk/src') },
+  get '@azure/functions' () { return require('../../../datadog-plugin-azure-functions/src') },
   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') },
@@ -22,6 +23,7 @@ module.exports = {
   get aerospike () { return require('../../../datadog-plugin-aerospike/src') },
   get amqp10 () { return require('../../../datadog-plugin-amqp10/src') },
   get amqplib () { return require('../../../datadog-plugin-amqplib/src') },
+  get avsc () { return require('../../../datadog-plugin-avsc/src') },
   get 'aws-sdk' () { return require('../../../datadog-plugin-aws-sdk/src') },
   get bunyan () { return require('../../../datadog-plugin-bunyan/src') },
   get 'cassandra-driver' () { return require('../../../datadog-plugin-cassandra-driver/src') },
@@ -77,6 +79,7 @@ module.exports = {
   get pino () { return require('../../../datadog-plugin-pino/src') },
   get 'pino-pretty' () { return require('../../../datadog-plugin-pino/src') },
   get playwright () { return require('../../../datadog-plugin-playwright/src') },
+  get protobufjs () { return require('../../../datadog-plugin-protobufjs/src') },
   get redis () { return require('../../../datadog-plugin-redis/src') },
   get restify () { return require('../../../datadog-plugin-restify/src') },
   get rhea () { return require('../../../datadog-plugin-rhea/src') },

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

@@ -54,7 +54,7 @@ module.exports = class LogPlugin extends Plugin {
   configure (config) {
     return super.configure({
       ...config,
-      enabled: config.enabled && config.logInjection
+      enabled: config.enabled && (config.logInjection || config.ciVisAgentlessLogSubmissionEnabled)
     })
   }
 }

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

@@ -0,0 +1,35 @@
+'use strict'
+
+const Plugin = require('./plugin')
+
+const SERIALIZATION = 'serialization'
+const DESERIALIZATION = 'deserialization'
+
+class SchemaPlugin extends Plugin {
+  constructor (...args) {
+    super(...args)
+
+    this.addSub(`apm:${this.constructor.id}:serialize-start`, this.handleSerializeStart.bind(this))
+    this.addSub(`apm:${this.constructor.id}:deserialize-end`, this.handleDeserializeFinish.bind(this))
+  }
+
+  handleSerializeStart (args) {
+    const activeSpan = this.tracer.scope().active()
+    if (activeSpan && this.config.dsmEnabled) {
+      this.constructor.schemaExtractor.attachSchemaOnSpan(
+        args, activeSpan, SERIALIZATION, this.tracer
+      )
+    }
+  }
+
+  handleDeserializeFinish (args) {
+    const activeSpan = this.tracer.scope().active()
+    if (activeSpan && this.config.dsmEnabled) {
+      this.constructor.schemaExtractor.attachSchemaOnSpan(
+        args, activeSpan, DESERIALIZATION, this.tracer
+      )
+    }
+  }
+}
+
+module.exports = SchemaPlugin

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

@@ -1,3 +1,4 @@
+const { readFileSync } = require('fs')
 const {
   GIT_BRANCH,
   GIT_COMMIT_SHA,
@@ -6,6 +7,9 @@ const {
   GIT_COMMIT_AUTHOR_NAME,
   GIT_COMMIT_MESSAGE,
   GIT_COMMIT_AUTHOR_DATE,
+  GIT_COMMIT_HEAD_SHA,
+  GIT_PULL_REQUEST_BASE_BRANCH_SHA,
+  GIT_PULL_REQUEST_BASE_BRANCH,
   GIT_REPOSITORY_URL,
   CI_PIPELINE_ID,
   CI_PIPELINE_NAME,
@@ -77,6 +81,13 @@ function resolveTilde (filePath) {
   return filePath
 }
 
+function getGitHubEventPayload () {
+  if (!process.env.GITHUB_EVENT_PATH) {
+    return
+  }
+  return JSON.parse(readFileSync(process.env.GITHUB_EVENT_PATH, 'utf8'))
+}
+
 module.exports = {
   normalizeRef,
   getCIMetadata () {
@@ -241,7 +252,8 @@ module.exports = {
         GITHUB_REPOSITORY,
         GITHUB_SERVER_URL,
         GITHUB_RUN_ATTEMPT,
-        GITHUB_JOB
+        GITHUB_JOB,
+        GITHUB_BASE_REF
       } = env
 
       const repositoryURL = `${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}.git`
@@ -277,6 +289,16 @@ module.exports = {
           GITHUB_RUN_ATTEMPT
         })
       }
+      if (GITHUB_BASE_REF) { // `pull_request` or `pull_request_target` event
+        tags[GIT_PULL_REQUEST_BASE_BRANCH] = GITHUB_BASE_REF
+        try {
+          const eventContent = getGitHubEventPayload()
+          tags[GIT_PULL_REQUEST_BASE_BRANCH_SHA] = eventContent.pull_request.base.sha
+          tags[GIT_COMMIT_HEAD_SHA] = eventContent.pull_request.head.sha
+        } catch (e) {
+          // ignore malformed event content
+        }
+      }
     }
 
     if (env.APPVEYOR) {

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

@@ -0,0 +1,7 @@
+const types = require('../../../../../ext/types')
+const web = require('./web')
+
+const serverless = { ...web }
+serverless.TYPE = types.SERVERLESS
+
+module.exports = serverless

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

@@ -0,0 +1,94 @@
+'use strict'
+
+const { relative, sep, isAbsolute } = require('path')
+
+const cwd = process.cwd()
+
+module.exports = {
+  getCallSites,
+  getUserLandFrames
+}
+
+// From https://github.com/felixge/node-stack-trace/blob/ba06dcdb50d465cd440d84a563836e293b360427/index.js#L1
+function getCallSites (constructorOpt) {
+  const oldLimit = Error.stackTraceLimit
+  Error.stackTraceLimit = Infinity
+
+  const dummy = {}
+
+  const v8Handler = Error.prepareStackTrace
+  Error.prepareStackTrace = function (_, v8StackTrace) {
+    return v8StackTrace
+  }
+  Error.captureStackTrace(dummy, constructorOpt)
+
+  const v8StackTrace = dummy.stack
+  Error.prepareStackTrace = v8Handler
+  Error.stackTraceLimit = oldLimit
+
+  return v8StackTrace
+}
+
+/**
+ * Get stack trace of user-land frames.
+ *
+ * @param {Function} constructorOpt - Function to pass along to Error.captureStackTrace
+ * @param {number} [limit=Infinity] - The maximum number of frames to return
+ * @returns {{ file: string, line: number, method: (string|undefined), type: (string|undefined) }[]} - A
+ */
+function getUserLandFrames (constructorOpt, limit = Infinity) {
+  const callsites = getCallSites(constructorOpt)
+  const frames = []
+
+  for (const callsite of callsites) {
+    if (callsite.isNative()) {
+      continue
+    }
+
+    const filename = callsite.getFileName()
+
+    // If the callsite is native, there will be no associated filename. However, there might be other instances where
+    // this can happen, so to be sure, we add this additional check
+    if (filename === null) {
+      continue
+    }
+
+    // ESM module paths start with the "file://" protocol (because ESM supports https imports)
+    // TODO: Node.js also supports `data:` and `node:` imports, should we do something specific for `data:`?
+    const containsFileProtocol = filename.startsWith('file:')
+
+    // TODO: I'm not sure how stable this check is. Alternatively, we could consider reversing it if we can get
+    // a comprehensive list of all non-file-based values, eg:
+    //
+    //     filename === '<anonymous>' || filename.startsWith('node:')
+    if (containsFileProtocol === false && isAbsolute(filename) === false) {
+      continue
+    }
+
+    // TODO: Technically, the algorithm below could be simplified to not use the relative path, but be simply:
+    //
+    //     if (filename.includes(sep + 'node_modules' + sep)) continue
+    //
+    // However, the tests in `packages/dd-trace/test/plugins/util/stacktrace.spec.js` will fail on my machine
+    // because I have the source code in a parent folder called `node_modules`. So the code below thinks that
+    // it's not in user-land
+    const relativePath = relative(cwd, containsFileProtocol ? filename.substring(7) : filename)
+    if (relativePath.startsWith('node_modules' + sep) || relativePath.includes(sep + 'node_modules' + sep)) {
+      continue
+    }
+
+    const method = callsite.getFunctionName()
+    const type = callsite.getTypeName()
+    frames.push({
+      file: filename,
+      line: callsite.getLineNumber(),
+      column: callsite.getColumnNumber(),
+      method: method ?? undefined, // force to undefined if null so JSON.stringify will omit it
+      type: type ?? undefined // force to undefined if null so JSON.stringify will omit it
+    })
+
+    if (frames.length === limit) break
+  }
+
+  return frames
+}

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

@@ -9,6 +9,10 @@ const GIT_COMMIT_COMMITTER_NAME = 'git.commit.committer.name'
 const GIT_COMMIT_AUTHOR_DATE = 'git.commit.author.date'
 const GIT_COMMIT_AUTHOR_EMAIL = 'git.commit.author.email'
 const GIT_COMMIT_AUTHOR_NAME = 'git.commit.author.name'
+const GIT_COMMIT_HEAD_SHA = 'git.commit.head_sha'
+
+const GIT_PULL_REQUEST_BASE_BRANCH_SHA = 'git.pull_request.base_branch_sha'
+const GIT_PULL_REQUEST_BASE_BRANCH = 'git.pull_request.base_branch'
 
 const CI_PIPELINE_ID = 'ci.pipeline.id'
 const CI_PIPELINE_NAME = 'ci.pipeline.name'
@@ -36,6 +40,9 @@ module.exports = {
   GIT_COMMIT_AUTHOR_DATE,
   GIT_COMMIT_AUTHOR_EMAIL,
   GIT_COMMIT_AUTHOR_NAME,
+  GIT_COMMIT_HEAD_SHA,
+  GIT_PULL_REQUEST_BASE_BRANCH_SHA,
+  GIT_PULL_REQUEST_BASE_BRANCH,
   CI_PIPELINE_ID,
   CI_PIPELINE_NAME,
   CI_PIPELINE_NUMBER,

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

@@ -168,7 +168,6 @@ module.exports = {
   mergeCoverage,
   fromCoverageMapToCoverage,
   getTestLineStart,
-  getCallSites,
   removeInvalidMetadata,
   parseAnnotations,
   EFD_STRING,
@@ -181,7 +180,8 @@ module.exports = {
   TEST_BROWSER_NAME,
   TEST_BROWSER_VERSION,
   getTestSessionName,
-  TEST_LEVEL_EVENT_TYPES
+  TEST_LEVEL_EVENT_TYPES,
+  getNumFromKnownTests
 }
 
 // Returns pkg manager and its version, separated by '-', e.g. npm-8.15.0 or yarn-1.22.19
@@ -557,26 +557,6 @@ function getTestLineStart (err, testSuitePath) {
   }
 }
 
-// From https://github.com/felixge/node-stack-trace/blob/ba06dcdb50d465cd440d84a563836e293b360427/index.js#L1
-function getCallSites () {
-  const oldLimit = Error.stackTraceLimit
-  Error.stackTraceLimit = Infinity
-
-  const dummy = {}
-
-  const v8Handler = Error.prepareStackTrace
-  Error.prepareStackTrace = function (_, v8StackTrace) {
-    return v8StackTrace
-  }
-  Error.captureStackTrace(dummy)
-
-  const v8StackTrace = dummy.stack
-  Error.prepareStackTrace = v8Handler
-  Error.stackTraceLimit = oldLimit
-
-  return v8StackTrace
-}
-
 /**
  * Gets an object of test tags from an Playwright annotations array.
  * @param {Object[]} annotations - Annotations from a Playwright test.
@@ -639,3 +619,21 @@ function getTestSessionName (config, testCommand, envTags) {
   }
   return testCommand
 }
+
+// Calculate the number of a tests from the known tests response, which has a shape like:
+// { testModule1: { testSuite1: [test1, test2, test3] }, testModule2: { testSuite2: [test4, test5] } }
+function getNumFromKnownTests (knownTests) {
+  if (!knownTests) {
+    return 0
+  }
+
+  let totalNumTests = 0
+
+  for (const testModule of Object.values(knownTests)) {
+    for (const testSuite of Object.values(testModule)) {
+      totalNumTests += testSuite.length
+    }
+  }
+
+  return totalNumTests
+}

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

@@ -36,6 +36,8 @@ const contexts = new WeakMap()
 const ends = new WeakMap()
 
 const web = {
+  TYPE: WEB,
+
   // Ensure the configuration has the correct structure and defaults.
   normalizeConfig (config) {
     const headers = getHeadersToRecord(config)
@@ -103,7 +105,7 @@ const web = {
     context.res = res
 
     this.setConfig(req, config)
-    addRequestTags(context)
+    addRequestTags(context, this.TYPE)
 
     return span
   },
@@ -296,7 +298,7 @@ const web = {
 
     if (context.finished && !req.stream) return
 
-    addRequestTags(context)
+    addRequestTags(context, this.TYPE)
     addResponseTags(context)
 
     context.config.hooks.request(context.span, req, res)
@@ -423,7 +425,7 @@ function reactivate (req, fn) {
     : fn()
 }
 
-function addRequestTags (context) {
+function addRequestTags (context, spanType) {
   const { req, span, config } = context
   const url = extractURL(req)
 
@@ -431,7 +433,7 @@ function addRequestTags (context) {
     [HTTP_URL]: web.obfuscateQs(config, url),
     [HTTP_METHOD]: req.method,
     [SPAN_KIND]: SERVER,
-    [SPAN_TYPE]: WEB,
+    [SPAN_TYPE]: spanType,
     [HTTP_USERAGENT]: req.headers['user-agent']
   })
 

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

@@ -146,6 +146,10 @@ class Profiler extends EventEmitter {
     const encodedProfiles = {}
 
     try {
+      if (Object.keys(this._config.profilers).length === 0) {
+        throw new Error('No profile types configured.')
+      }
+
       // collect profiles synchronously so that profilers can be safely stopped asynchronously
       for (const profiler of this._config.profilers) {
         const profile = profiler.profile(restart, startDate, endDate)
@@ -156,23 +160,32 @@ class Profiler extends EventEmitter {
         profiles.push({ profiler, profile })
       }
 
+      if (restart) {
+        this._capture(this._timeoutInterval, endDate)
+      }
+
       // encode and export asynchronously
       for (const { profiler, profile } of profiles) {
-        encodedProfiles[profiler.type] = await profiler.encode(profile)
-        this._logger.debug(() => {
-          const profileJson = JSON.stringify(profile, (key, value) => {
-            return typeof value === 'bigint' ? value.toString() : value
+        try {
+          encodedProfiles[profiler.type] = await profiler.encode(profile)
+          this._logger.debug(() => {
+            const profileJson = JSON.stringify(profile, (key, value) => {
+              return typeof value === 'bigint' ? value.toString() : value
+            })
+            return `Collected ${profiler.type} profile: ` + profileJson
           })
-          return `Collected ${profiler.type} profile: ` + profileJson
-        })
+        } catch (err) {
+          // If encoding one of the profile types fails, we should still try to
+          // encode and submit the other profile types.
+          this._logError(err)
+        }
       }
 
-      if (restart) {
-        this._capture(this._timeoutInterval, endDate)
+      if (Object.keys(encodedProfiles).length > 0) {
+        await this._submit(encodedProfiles, startDate, endDate, snapshotKind)
+        profileSubmittedChannel.publish()
+        this._logger.debug('Submitted profiles')
       }
-      await this._submit(encodedProfiles, startDate, endDate, snapshotKind)
-      profileSubmittedChannel.publish()
-      this._logger.debug('Submitted profiles')
     } catch (err) {
       this._logError(err)
       this._stop()
@@ -180,9 +193,6 @@ class Profiler extends EventEmitter {
   }
 
   _submit (profiles, start, end, snapshotKind) {
-    if (!Object.keys(profiles).length) {
-      return Promise.reject(new Error('No profiles to submit'))
-    }
     const { tags } = this._config
     const tasks = []
 

package/packages/dd-trace/src/profiling/profilers/events.js

@@ -330,13 +330,13 @@ class EventsProfiler {
     if (!restart) {
       this.stop()
     }
-    const profile = this.eventSerializer.createProfile(startDate, endDate)
+    const thatEventSerializer = this.eventSerializer
     this.eventSerializer = new EventSerializer()
-    return profile
+    return () => thatEventSerializer.createProfile(startDate, endDate)
   }
 
   encode (profile) {
-    return pprof.encode(profile)
+    return pprof.encode(profile())
   }
 }