dd-trace 5.57.1 → 5.59.0

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

@@ -1,12 +1,15 @@
 'use strict'
 
-const { relative, sep, isAbsolute } = require('path')
+const { relative, sep } = require('path')
 
 const cwd = process.cwd()
 
+const NODE_MODULES_PATTERN_MIDDLE = `${sep}node_modules${sep}`
+const NODE_MODULES_PATTERN_START = `node_modules${sep}`
+
 module.exports = {
   getCallSites,
-  getUserLandFrames
+  parseUserLandFrames
 }
 
 // From https://github.com/felixge/node-stack-trace/blob/ba06dcdb50d465cd440d84a563836e293b360427/index.js#L1
@@ -32,70 +35,195 @@ function getCallSites (constructorOpt) {
 /**
  * Get stack trace of user-land frames.
  *
- * @param {Function} constructorOpt - Function to pass along to Error.captureStackTrace
+ * @param {string} stack - The stack trace to parse
  * @param {number} [limit=Infinity] - The maximum number of frames to return
  * @returns {StackFrame[]} - A list of stack frames from user-land code
+ */
+function parseUserLandFrames (stack, limit = Infinity) {
+  let index = stack.indexOf('\n    at ')
+  const frames = []
+
+  while (index !== -1 && frames.length !== limit) {
+    const nextIndex = stack.indexOf('\n', index + 1)
+    const frame = parseLine(stack, index, nextIndex === -1 ? stack.length : nextIndex)
+    if (frame !== undefined) frames.push(frame)
+    index = nextIndex
+  }
+
+  return frames
+}
+
+/**
+ * Parses a line of the stack trace and returns the parsed frame if it is a user-land frame.
+ * Returns `undefined` otherwise.
+ *
+ * @param {string} stack - The stack trace in which the line is located.
+ * @param {number} start - The start index of the line to parse within the stack trace.
+ * @param {number} end - The end index of the line to parse within the stack trace.
+ * @returns {StackFrame|undefined} The parsed frame if it is a user frame, `undefined` otherwise.
  *
  * @typedef {Object} StackFrame
- * @property {string} file - The file path of the frame
- * @property {number} line - The line number in the file
- * @property {number} column - The column number in the file
- * @property {string} [method] - The function name, if available
- * @property {string} [type] - The type name, if available
+ * @property {string} fileName - The file name of the frame.
+ * @property {string} lineNumber - The line number of the frame.
+ * @property {string} columnNumber - The column number of the frame.
+ * @property {string} [functionName] - The function name of the frame.
+ * @property {string} [methodName] - The method name of the frame.
+ * @property {string} [typeName] - The type name of the frame.
  */
-function getUserLandFrames (constructorOpt, limit = Infinity) {
-  const callsites = getCallSites(constructorOpt)
-  const frames = []
+function parseLine (stack, start, end) {
+  let index
+  if (stack[end - 1] === ')') {
+    index = end - 2 // skip the last closing parenthesis
+    const code = stack.charCodeAt(index)
+    if (code < 0x30 || code > 0x39) return // not a digit
+  } else {
+    index = end - 1
+  }
 
-  for (const callsite of callsites) {
-    if (callsite.isNative()) {
-      continue
+  start += 8 // skip the `\n    at ` prefix
+  if (stack.startsWith('new ', start)) start += 4 // skip `new `
+  else if (stack.startsWith('async ', start)) start += 6 // skip `async `
+
+  let fileName, lineNumber, columnNumber
+  const result = parseLocation(stack, start, index)
+  if (result === undefined) return
+  [fileName, lineNumber, columnNumber, index] = result
+
+  if (isNodeModulesFrame(fileName)) return
+
+  // parse method name
+  let methodName, functionName
+  if (stack[index] === ']') {
+    methodName = ''
+    index-- // skip the closing square bracket
+    for (; index >= start; index--) {
+      const char = stack[index]
+      if (char === ' ' && stack.slice(index - 4, index) === ' [as') {
+        // The space after `[as` in `[as Foo]`
+        index -= 4 // skip ` [as`
+        break
+      } else if (char === '[') {
+        // This isn't a method name after all, but probably a symbol
+        functionName = `${stack.slice(start, index)}[${methodName}]`
+        methodName = undefined
+        break
+      }
+      methodName = char + methodName
     }
+    index-- // skip the opening square bracket
+  }
 
-    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
+  // parse function and type name
+  functionName ??= start <= index ? stack.slice(start, index + 1) : undefined
+  let typeName
+  if (functionName !== undefined && functionName[0] !== '[') {
+    const periodIndex = functionName.indexOf('.')
+    if (periodIndex !== -1) {
+      typeName = functionName.slice(0, periodIndex)
+      functionName = functionName.slice(periodIndex + 1)
     }
+  }
+
+  return {
+    lineNumber,
+    columnNumber,
+    fileName,
+    methodName,
+    functionName,
+    typeName
+  }
+}
+
+// TODO: Technically, the algorithm below could be simplified to not use the relative path, but be simply:
+//
+//     return filename.includes(NODE_MODULES_PATTERN_MIDDLE))
+//
+// However, if the user happens to be running this within a directory where `node_modules` is one of the parent
+// directories, it will be flagged as a false positive.
+function isNodeModulesFrame (fileName) {
+  // Quick check first - if it doesn't contain node_modules, it's not a node_modules frame
+  if (!fileName.includes(NODE_MODULES_PATTERN_MIDDLE)) {
+    return false
+  }
+
+  // More expensive relative path calculation only when necessary
+  const actualPath = fileName.startsWith('file:') ? fileName.slice(7) : fileName
+  const relativePath = relative(cwd, actualPath)
 
-    // 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:')
+  return relativePath.startsWith(NODE_MODULES_PATTERN_START) || relativePath.includes(NODE_MODULES_PATTERN_MIDDLE)
+}
 
-    // 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) {
+/**
+ * A stack trace location can be in one of the following formats:
+ *
+ * 1. `myscript.js:10:3`
+ * 2. `(myscript.js:10:3`
+ * 3. `(eval at Foo.a (myscript.js:10:3)`
+ * 4. `(eval at Foo.a (myscript.js:10:3), <anonymous>:1:1`
+ * 5. `(eval at Foo.a (eval at Bar.z (myscript.js:10:3)`
+ * 6. `(eval at Foo.a (eval at Bar.z (myscript.js:10:3), <anonymous>:1:1`
+ *
+ * Notice how the optional closing parenthesis is not included in the location string at this point. It has been
+ * skipped to save time.
+ *
+ * This function extracts the `myscript.js:10:3` part, passes it, returns the file name, line number, and column
+ * number and sets the `index` to the start of the whole location string.
+ *
+ * @returns {[string, string, string, number]|undefined}
+ */
+function parseLocation (stack, start, index) {
+  // parse column number
+  let columnNumber = ''
+  for (; index >= start; index--) {
+    const code = stack.charCodeAt(index)
+    if (code === 0x29) { // closing parenthesis
+      // e.g. `eval at Foo.a (eval at Bar.z (myscript.js:10:3))`
       continue
     }
+    if (code < 0x30 || code > 0x39) break // not a digit
+    columnNumber = stack[index] + columnNumber
+  }
 
-    // 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.slice(7) : filename)
-    if (relativePath.startsWith('node_modules' + sep) || relativePath.includes(sep + 'node_modules' + sep)) {
-      continue
+  index-- // skip colon
+
+  // parse line number
+  let lineNumber = ''
+  for (; index >= start; index--) {
+    const code = stack.charCodeAt(index)
+    if (code < 0x30 || code > 0x39) break // not a digit
+    lineNumber = stack[index] + lineNumber
+  }
+
+  index-- // skip colon
+
+  // parse file name
+  let nestedParenthesis = 1 // 1 instead of 0 because the trailing parenthesis wasn't seen by this function
+  let fileName = ''
+  for (; index >= start; index--) {
+    const char = stack[index]
+    if (char === ')') {
+      nestedParenthesis++
+    } else if (char === '(' && --nestedParenthesis === 0) {
+      index -= 2 // skip the opening parenthesis and the whitespace before it
+      break
+    } else if (nestedParenthesis === 1 && char === ':' && stack.slice(index - 4, index) === 'node') {
+      return // e.g. `node:vm:137:12` is not considered a user frame
     }
+    fileName = char + fileName
+  }
 
-    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
+  if (fileName.startsWith('eval at ')) {
+    // The location we parsed was not the actual location, but the location inside the eval. Let's parse the nested
+    // location, which will be the location of the eval.
+    const result = parseLocation(fileName, 0, fileName.lastIndexOf(',') - 2)
+    if (result === undefined) return
+    [fileName, lineNumber, columnNumber] = result // ignore returned index, as we need to retain the original one
   }
 
-  return frames
+  return [
+    fileName,
+    lineNumber,
+    columnNumber,
+    index // return the index, so the caller knows how far we got
+  ]
 }

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

@@ -1,3 +1,5 @@
+'use strict'
+
 const GIT_COMMIT_SHA = 'git.commit.sha'
 const GIT_BRANCH = 'git.branch'
 const GIT_REPOSITORY_URL = 'git.repository_url'
@@ -9,7 +11,14 @@ 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_COMMIT_HEAD_SHA = 'git.commit.head.sha'
+const GIT_COMMIT_HEAD_MESSAGE = 'git.commit.head.message'
+const GIT_COMMIT_HEAD_AUTHOR_DATE = 'git.commit.head.author.date'
+const GIT_COMMIT_HEAD_AUTHOR_EMAIL = 'git.commit.head.author.email'
+const GIT_COMMIT_HEAD_AUTHOR_NAME = 'git.commit.head.author.name'
+const GIT_COMMIT_HEAD_COMMITER_DATE = 'git.commit.head.commiter.date'
+const GIT_COMMIT_HEAD_COMMITER_EMAIL = 'git.commit.head.commiter.email'
+const GIT_COMMIT_HEAD_COMMITER_NAME = 'git.commit.head.commiter.name'
 
 const GIT_PULL_REQUEST_BASE_BRANCH_SHA = 'git.pull_request.base_branch_sha'
 const GIT_PULL_REQUEST_BASE_BRANCH = 'git.pull_request.base_branch'
@@ -43,6 +52,13 @@ module.exports = {
   GIT_COMMIT_AUTHOR_EMAIL,
   GIT_COMMIT_AUTHOR_NAME,
   GIT_COMMIT_HEAD_SHA,
+  GIT_COMMIT_HEAD_MESSAGE,
+  GIT_COMMIT_HEAD_AUTHOR_DATE,
+  GIT_COMMIT_HEAD_AUTHOR_EMAIL,
+  GIT_COMMIT_HEAD_AUTHOR_NAME,
+  GIT_COMMIT_HEAD_COMMITER_DATE,
+  GIT_COMMIT_HEAD_COMMITER_EMAIL,
+  GIT_COMMIT_HEAD_COMMITER_NAME,
   GIT_PULL_REQUEST_BASE_BRANCH_SHA,
   GIT_PULL_REQUEST_BASE_BRANCH,
   CI_PIPELINE_ID,

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

@@ -1,3 +1,5 @@
+'use strict'
+
 const path = require('path')
 const fs = require('fs')
 const { URL } = require('url')
@@ -32,7 +34,8 @@ const {
   GIT_COMMIT_MESSAGE,
   CI_WORKSPACE_PATH,
   CI_PIPELINE_URL,
-  CI_JOB_NAME
+  CI_JOB_NAME,
+  GIT_COMMIT_HEAD_SHA
 } = require('./tags')
 const id = require('../../id')
 const {
@@ -446,7 +449,8 @@ function getTestEnvironmentMetadata (testFramework, config) {
     [GIT_COMMIT_AUTHOR_NAME]: authorName,
     [GIT_COMMIT_AUTHOR_EMAIL]: authorEmail,
     [GIT_COMMIT_MESSAGE]: commitMessage,
-    [CI_WORKSPACE_PATH]: ciWorkspacePath
+    [CI_WORKSPACE_PATH]: ciWorkspacePath,
+    [GIT_COMMIT_HEAD_SHA]: headCommitSha
   } = ciMetadata
 
   const gitMetadata = getGitMetadata({
@@ -457,7 +461,8 @@ function getTestEnvironmentMetadata (testFramework, config) {
     authorName,
     authorEmail,
     commitMessage,
-    ciWorkspacePath
+    ciWorkspacePath,
+    headCommitSha
   })
 
   const userProvidedGitMetadata = getUserProviderGitMetadata()
@@ -975,7 +980,7 @@ function getLibraryCapabilitiesTags (testFramework, isParallel, frameworkVersion
       : undefined,
     [DD_CAPABILITIES_TEST_MANAGEMENT_ATTEMPT_TO_FIX]:
       isAttemptToFixSupported(testFramework, isParallel, frameworkVersion)
-        ? '4'
+        ? '5'
         : undefined,
     [DD_CAPABILITIES_FAILED_TEST_REPLAY]: isFailedTestReplaySupported(testFramework, frameworkVersion)
       ? '1'

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

@@ -1,3 +1,5 @@
+'use strict'
+
 const { URL } = require('url')
 
 function filterSensitiveInfoFromRepository (repositoryUrl) {

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

@@ -1,3 +1,5 @@
+'use strict'
+
 const {
   GIT_COMMIT_SHA,
   GIT_BRANCH,

package/packages/dd-trace/src/profiling/exporters/event_serializer.js

@@ -1,3 +1,7 @@
+'use strict'
+
+/* eslint n/no-unsupported-features/node-builtins: ['error', { ignores: ['os.availableParallelism'] }] */
+
 const os = require('os')
 const perf = require('perf_hooks').performance
 const version = require('../../../../../package.json').version