dd-trace 6.7.0 → 6.9.0

package/ci/test-optimization-validation/generated-files.js

@@ -1,7 +1,7 @@
 'use strict'
 
-const fs = require('fs')
-const path = require('path')
+const fs = require('node:fs')
+const path = require('node:path')
 
 const {
   MAX_GENERATED_FILES,
@@ -91,14 +91,16 @@ function cleanupGeneratedFiles (manifest, { keep = false } = {}) {
     filesRemoved: 0,
     filesRetained: 0,
   }
-  for (const framework of manifest.frameworks || []) {
-    const strategy = framework.generatedTestStrategy
-    addCleanupOutcome(
-      outcome,
-      cleanupPaths(getSafeCleanupPaths(framework, strategy, { includeGeneratedFiles: true })),
-      'files'
-    )
-    addCleanupOutcome(outcome, cleanupCreatedDirectories(framework.project.root), 'directories')
+  if (manifest.frameworks) {
+    for (const framework of manifest.frameworks) {
+      const strategy = framework.generatedTestStrategy
+      addCleanupOutcome(
+        outcome,
+        cleanupPaths(getSafeCleanupPaths(framework, strategy, { includeGeneratedFiles: true })),
+        'files'
+      )
+      addCleanupOutcome(outcome, cleanupCreatedDirectories(framework.project.root), 'directories')
+    }
   }
   outcome.status = outcome.filesRetained > 0 || outcome.directoriesRetained > 0
     ? 'incomplete'
@@ -132,7 +134,7 @@ function getMissingDirectories (root, directory) {
 function cleanupCreatedDirectories (root) {
   const outcome = { removed: 0, retained: 0 }
   const resolvedRoot = path.resolve(root)
-  const directories = [...createdGeneratedDirectories.entries()]
+  const directories = [...createdGeneratedDirectories]
     .filter(([directory]) => isPathInside(resolvedRoot, directory))
     .sort(([left], [right]) => right.length - left.length)
 
@@ -168,13 +170,15 @@ function initializeRuntimeCleanupFiles (framework, strategy) {
   if (initializedCleanupStrategies.has(strategy)) return
 
   const generatedFiles = new Set((strategy.files || []).map(file => validateGeneratedFilePath(framework, file.path)))
-  for (const cleanupPath of strategy.cleanupPaths || []) {
-    const filename = validateCleanupPath(framework, cleanupPath)
-    if (generatedFiles.has(filename) || isDirectory(filename) || !isNamespacedRuntimeFile(filename)) continue
-    if (fs.existsSync(filename)) {
-      throw new Error(`Refusing to delete pre-existing generated validation runtime file: ${filename}`)
+  if (strategy.cleanupPaths) {
+    for (const cleanupPath of strategy.cleanupPaths) {
+      const filename = validateCleanupPath(framework, cleanupPath)
+      if (generatedFiles.has(filename) || isDirectory(filename) || !isNamespacedRuntimeFile(filename)) continue
+      if (fs.existsSync(filename)) {
+        throw new Error(`Refusing to delete pre-existing generated validation runtime file: ${filename}`)
+      }
+      authorizedRuntimeCleanupFiles.set(filename, authorizePathForCleanup(framework.project.root, filename))
     }
-    authorizedRuntimeCleanupFiles.set(filename, authorizePathForCleanup(framework.project.root, filename))
   }
   initializedCleanupStrategies.add(strategy)
 }
@@ -183,20 +187,24 @@ function getSafeCleanupPaths (framework, strategy, { includeGeneratedFiles }) {
   if (!strategy) return []
 
   const generatedFiles = new Set()
-  for (const file of strategy.files || []) {
-    generatedFiles.add(validateGeneratedFilePath(framework, file.path))
+  if (strategy.files) {
+    for (const file of strategy.files) {
+      generatedFiles.add(validateGeneratedFilePath(framework, file.path))
+    }
   }
 
   const cleanupPaths = []
-  for (const cleanupPath of strategy.cleanupPaths || []) {
-    const filename = validateCleanupPath(framework, cleanupPath)
-    if (generatedFiles.has(filename)) {
-      if (includeGeneratedFiles && writtenGeneratedFiles.has(filename)) cleanupPaths.push(filename)
-      continue
-    }
+  if (strategy.cleanupPaths) {
+    for (const cleanupPath of strategy.cleanupPaths) {
+      const filename = validateCleanupPath(framework, cleanupPath)
+      if (generatedFiles.has(filename)) {
+        if (includeGeneratedFiles && writtenGeneratedFiles.has(filename)) cleanupPaths.push(filename)
+        continue
+      }
 
-    if (authorizedRuntimeCleanupFiles.has(filename)) {
-      cleanupPaths.push(filename)
+      if (authorizedRuntimeCleanupFiles.has(filename)) {
+        cleanupPaths.push(filename)
+      }
     }
   }
 
@@ -251,7 +259,7 @@ function forgetWrittenGeneratedFiles (filenames) {
 function authorizePathForCleanup (root, filename) {
   const lexicalRoot = path.resolve(root)
   const physicalRoot = fs.realpathSync(lexicalRoot)
-  const rootStat = fs.statSync(physicalRoot)
+  const rootStat = fs.statSync(physicalRoot, { bigint: true })
   const authorization = {
     lexicalRoot,
     physicalRoot,
@@ -264,10 +272,12 @@ function authorizePathForCleanup (root, filename) {
 }
 
 function pinRuntimeCleanupParents (strategy) {
-  for (const cleanupPath of strategy.cleanupPaths || []) {
-    const authorization = authorizedRuntimeCleanupFiles.get(path.resolve(cleanupPath))
-    if (authorization && authorization.physicalParent === undefined) {
-      pinCleanupParent(authorization, cleanupPath)
+  if (strategy.cleanupPaths) {
+    for (const cleanupPath of strategy.cleanupPaths) {
+      const authorization = authorizedRuntimeCleanupFiles.get(path.resolve(cleanupPath))
+      if (authorization && authorization.physicalParent === undefined) {
+        pinCleanupParent(authorization, cleanupPath)
+      }
     }
   }
 }
@@ -276,7 +286,7 @@ function pinCleanupParent (authorization, filename) {
   try {
     const physicalParent = fs.realpathSync(path.dirname(filename))
     if (!isPathInside(authorization.physicalRoot, physicalParent)) return
-    const parentStat = fs.statSync(physicalParent)
+    const parentStat = fs.statSync(physicalParent, { bigint: true })
     authorization.physicalParent = physicalParent
     authorization.parentDevice = parentStat.dev
     authorization.parentInode = parentStat.ino
@@ -285,7 +295,7 @@ function pinCleanupParent (authorization, filename) {
 
 function pinCleanupTarget (authorization, filename) {
   try {
-    const targetStat = fs.lstatSync(filename)
+    const targetStat = fs.lstatSync(filename, { bigint: true })
     authorization.targetDevice = targetStat.dev
     authorization.targetInode = targetStat.ino
   } catch {}
@@ -294,7 +304,7 @@ function pinCleanupTarget (authorization, filename) {
 function isCleanupAuthorizationValid (filename, authorization) {
   try {
     const currentPhysicalRoot = fs.realpathSync(authorization.lexicalRoot)
-    const rootStat = fs.statSync(currentPhysicalRoot)
+    const rootStat = fs.statSync(currentPhysicalRoot, { bigint: true })
     if (currentPhysicalRoot !== authorization.physicalRoot ||
       rootStat.dev !== authorization.rootDevice || rootStat.ino !== authorization.rootInode) {
       return false
@@ -302,14 +312,14 @@ function isCleanupAuthorizationValid (filename, authorization) {
 
     if (authorization.physicalParent === undefined) return false
     const physicalParent = fs.realpathSync(path.dirname(filename))
-    const parentStat = fs.statSync(physicalParent)
+    const parentStat = fs.statSync(physicalParent, { bigint: true })
     if (physicalParent !== authorization.physicalParent ||
       parentStat.dev !== authorization.parentDevice || parentStat.ino !== authorization.parentInode) {
       return false
     }
 
     if (authorization.targetDevice !== undefined) {
-      const targetStat = fs.lstatSync(filename)
+      const targetStat = fs.lstatSync(filename, { bigint: true })
       if (targetStat.dev !== authorization.targetDevice || targetStat.ino !== authorization.targetInode) {
         return false
       }

package/ci/test-optimization-validation/generated-test-contract.js

@@ -79,7 +79,7 @@ function getGeneratedTestContent ({ framework, moduleSystem, scenarioId, stateFi
     const requireCall = 'require'
     imports.push(moduleSystem === 'esm'
       ? "import { describe, expect, test } from '@jest/globals'"
-      : `const { describe, expect, test } = ${requireCall}('@jest/globals')`)
+      : `const jestGlobals = ${requireCall}('@jest/globals')`)
   }
   if (framework === 'vitest' && moduleSystem === 'esm') {
     imports.push("import { describe, expect, it } from 'vitest'")
@@ -97,8 +97,12 @@ function getGeneratedTestContent ({ framework, moduleSystem, scenarioId, stateFi
     }
   }
 
-  const assertion = framework === 'mocha' ? 'assert.equal(1, 1)' : 'expect(true).toBe(true)'
-  const testFunction = framework === 'jest' ? 'test' : 'it'
+  const commonJsJest = framework === 'jest' && moduleSystem === 'commonjs'
+  const assertion = framework === 'mocha'
+    ? 'assert.equal(1, 1)'
+    : `${commonJsJest ? 'jestGlobals.' : ''}expect(true).toBe(true)`
+  const testFunction = framework === 'jest' ? `${commonJsJest ? 'jestGlobals.' : ''}test` : 'it'
+  const describeFunction = commonJsJest ? 'jestGlobals.describe' : 'describe'
   const body = scenarioId === 'atr-fail-once'
     ? getAtrBody({ moduleSystem, assertion, stateFile })
     : `    ${assertion}`
@@ -106,7 +110,7 @@ function getGeneratedTestContent ({ framework, moduleSystem, scenarioId, stateFi
   return [
     ...imports,
     imports.length > 0 ? '' : undefined,
-    "describe('dd-test-optimization-validation', () => {",
+    `${describeFunction}('dd-test-optimization-validation', () => {`,
     `  ${testFunction}('${scenario.testName}', () => {`,
     body,
     '  })',
@@ -192,9 +196,7 @@ function getGeneratedTestContractError (framework) {
     if (!cleanupPaths.has(path.normalize(stepsFile))) {
       return 'must include the isolated Cucumber step definitions in cleanupPaths.'
     }
-  }
-
-  if (framework.framework === 'playwright') {
+  } else if (framework.framework === 'playwright') {
     const configPath = playwrightAdapter.getGeneratedConfigPath(strategy.testDirectory)
     const config = files.find(file => path.normalize(file.path) === path.normalize(configPath))
     if (config?.contentLines?.join('\n') !== playwrightAdapter.getGeneratedConfigContent()) {

package/ci/test-optimization-validation/generated-verifier.js

@@ -3,6 +3,7 @@
 const fs = require('node:fs')
 const path = require('node:path')
 
+const { BLOCKER_CATEGORIES, getBlockerDomain } = require('./blocker-category')
 const { getCommandBlocker } = require('./command-blocker')
 const { runCommand, serializeDisplayCommand } = require('./command-runner')
 const {
@@ -12,6 +13,7 @@ const {
 const { getGeneratedCommand } = require('./runner-command')
 const { frameworkOutDir } = require('./scenarios/helpers')
 const { getObservedTestCount } = require('./test-output')
+const { getValidationBlockerEvidence } = require('./validation-blocker')
 
 const GENERATED_SCENARIO_BY_FEATURE = {
   efd: 'basic-pass',
@@ -103,15 +105,16 @@ async function verifyGeneratedTestStrategy ({ framework, out, options }) {
     return { ok: true }
   } catch (error) {
     cleanupGeneratedRuntimeFiles(framework)
+    const blockerEvidence = getValidationBlockerEvidence(error)
     return {
       ok: false,
       failure: {
         frameworkId: framework.id,
         scenario: 'generated-test-verification',
-        status: 'error',
+        status: blockerEvidence ? 'blocked' : 'error',
         diagnosis: 'The validator could not run the temporary validation test as expected. No advanced-feature ' +
           `conclusion was reached: ${error.message || error}`,
-        evidence,
+        evidence: { ...evidence, ...blockerEvidence },
         artifacts,
       },
     }
@@ -153,14 +156,12 @@ function getVerificationFailure (framework, evidence, artifacts, scenario, resul
   const commandFailure = getCommandBlocker(result, {
     browserRequired: framework.browserRequired,
     framework: framework.framework,
+    packageJson: framework.project.packageJson,
     testsRan: Number.isInteger(observedTestCount) && observedTestCount > 0,
   })
   if (commandFailure) {
-    const domain = commandFailure.blockedByExecutionEnvironment
-      ? 'execution_environment'
-      : commandFailure.localRuntimeBlocked
-        ? 'local_runtime'
-        : 'project_setup'
+    const blockerCategory = commandFailure.blockerCategory
+    const domain = getBlockerDomain(blockerCategory)
     return {
       ok: false,
       failure: {
@@ -168,7 +169,7 @@ function getVerificationFailure (framework, evidence, artifacts, scenario, resul
         scenario: 'generated-test-verification',
         status: 'blocked',
         diagnosis: `${commandFailure.summary} Advanced-feature validation could not start reliably.`,
-        evidence: { ...evidence, commandFailure, domain, validationIncomplete: true },
+        evidence: { ...evidence, blockerCategory, commandFailure, domain, validationIncomplete: true },
         artifacts,
       },
     }
@@ -189,7 +190,11 @@ function getVerificationFailure (framework, evidence, artifacts, scenario, resul
       scenario: 'generated-test-verification',
       status: 'error',
       diagnosis: `Temporary validation test "${scenario.id}" ${reason}. No advanced-feature conclusion was reached.`,
-      evidence,
+      evidence: {
+        ...evidence,
+        blockerCategory: BLOCKER_CATEGORIES.VALIDATOR_LIMITATION,
+        validationIncomplete: true,
+      },
       artifacts,
     },
   }
@@ -204,14 +209,16 @@ function getVerificationFailure (framework, evidence, artifacts, scenario, resul
 function getGeneratedRuntimeFileStatus (strategy) {
   const generatedFiles = new Set((strategy.files || []).map(file => path.resolve(file.path)))
   let expectsRuntimeFile = false
-  for (const cleanupPath of strategy.cleanupPaths || []) {
-    const filename = path.resolve(cleanupPath)
-    if (generatedFiles.has(filename)) continue
-    expectsRuntimeFile = true
-    try {
-      const stat = fs.lstatSync(filename)
-      if (!stat.isSymbolicLink() && stat.isFile()) return true
-    } catch {}
+  if (strategy.cleanupPaths) {
+    for (const cleanupPath of strategy.cleanupPaths) {
+      const filename = path.resolve(cleanupPath)
+      if (generatedFiles.has(filename)) continue
+      expectsRuntimeFile = true
+      try {
+        const stat = fs.lstatSync(filename)
+        if (!stat.isSymbolicLink() && stat.isFile()) return true
+      } catch {}
+    }
   }
   return expectsRuntimeFile ? false : undefined
 }

package/ci/test-optimization-validation/literal-glob.js

@@ -0,0 +1,52 @@
+'use strict'
+
+// Dynamic extglobs, negation, character classes, and malformed braces fail closed.
+function matchesLiteralGlob (filename, pattern) {
+  const source = String(pattern || '').replaceAll('\\', '/').replace(/^\.\//, '')
+  if (!source || /[!()[\]]/.test(source)) return false
+
+  let expression = '^'
+  for (let index = 0; index < source.length; index++) {
+    const character = source[index]
+    if (character === '*') {
+      if (source[index + 1] === '*') {
+        index++
+        if (source[index + 1] === '/') {
+          index++
+          expression += '(?:.*/)?'
+        } else {
+          expression += '.*'
+        }
+      } else {
+        expression += '[^/]*'
+      }
+      continue
+    }
+    if (character === '?') {
+      expression += '[^/]'
+      continue
+    }
+    if (character === '{') {
+      const end = source.indexOf('}', index + 1)
+      if (end === -1) return false
+      const alternatives = source.slice(index + 1, end).split(',')
+      if (alternatives.length < 2 || alternatives.some(value => !/^[A-Za-z0-9._-]+$/.test(value))) return false
+      expression += `(?:${alternatives.map(escapeRegExp).join('|')})`
+      // eslint-disable-next-line sonarjs/updated-loop-counter
+      index = end
+      continue
+    }
+    expression += escapeRegExp(character)
+  }
+  try {
+    return new RegExp(`${expression}$`).test(String(filename).replaceAll('\\', '/').replaceAll(/^\.\//g, ''))
+  } catch {
+    return false
+  }
+}
+
+function escapeRegExp (value) {
+  return value.replaceAll(/[.*+?^${}()|[\]\\]/g, String.raw`\$&`)
+}
+
+module.exports = { matchesLiteralGlob }

package/ci/test-optimization-validation/manifest-loader.js

@@ -81,6 +81,9 @@ function getManifestPaths (manifest) {
       [`${prefix}.ciWiring.configFile`, framework.ciWiring?.configFile],
       [`${prefix}.ciWiring.workingDirectory`, framework.ciWiring?.workingDirectory]
     )
+    for (const [index, fallback] of (framework.validation?.fallbackTests || []).entries()) {
+      paths.push([`${prefix}.validation.fallbackTests[${index}].testFile`, fallback.testFile])
+    }
     for (const [index, configFile] of (framework.project?.configFiles || []).entries()) {
       paths.push([`${prefix}.project.configFiles[${index}]`, configFile])
     }