dd-trace 6.4.0 → 6.5.0

package/ci/test-optimization-validation/command-blocker.js

@@ -0,0 +1,81 @@
+'use strict'
+
+const FILESYSTEM_PERMISSION_PATTERN = /\b(?:EACCES|EPERM|Operation not permitted|Permission denied)\b/i
+const PACKAGE_MANAGER_PATH_PATTERN = /(?:^|[/\\.])(?:corepack|npm|pnpm|yarn)(?:$|[/\\.])/i
+const WATCHMAN_PATTERN = /\bwatchman\b/i
+
+/**
+ * Identifies toolchain and execution-environment failures that happen before tests start.
+ *
+ * @param {object} result command result
+ * @param {string} [result.stdout] captured stdout
+ * @param {string} [result.stderr] captured stderr
+ * @returns {object|undefined} structured blocker diagnosis
+ */
+function getCommandBlocker (result) {
+  const output = `${result.stdout || ''}\n${result.stderr || ''}`
+  const yarnVersions = output.match(
+    /defines "packageManager": "(yarn@[^"]+)"[\s\S]*?current global version of Yarn is ([0-9][0-9.]*)\./i
+  )
+  if (yarnVersions) {
+    return {
+      kind: 'package-manager-version-mismatch',
+      summary: `The test command did not start because it resolved Yarn ${yarnVersions[2]}, but package.json ` +
+        `requires ${yarnVersions[1]}. No Test Optimization conclusion was reached.`,
+      recommendation: 'Run the approved command through the project-declared Yarn version, using its configured ' +
+        '`yarnPath` or an explicit Corepack Yarn command, then render and approve a fresh plan.',
+      signals: getMatchingLines(output, /packageManager|current global version of Yarn/i),
+      toolchainBlocked: true,
+    }
+  }
+
+  if (WATCHMAN_PATTERN.test(output) && FILESYSTEM_PERMISSION_PATTERN.test(output)) {
+    return {
+      kind: 'watchman-filesystem-blocked',
+      summary: 'The execution environment blocked Watchman state access before tests started. No CI wiring or ' +
+        'Test Optimization conclusion was reached.',
+      recommendation: 'Rerun in an environment where Watchman can access its state directory. If the CI job ' +
+        'itself disables Watchman, preserve that exact setting in the replay command.',
+      signals: getMatchingLines(output, /watchman|EACCES|EPERM|Operation not permitted|Permission denied/i),
+      blockedByExecutionEnvironment: true,
+    }
+  }
+
+  const permissionLines = getMatchingLines(
+    output,
+    /EACCES|EPERM|Operation not permitted|Permission denied/i
+  )
+  if (permissionLines.some(line => PACKAGE_MANAGER_PATH_PATTERN.test(line))) {
+    return {
+      kind: 'package-manager-filesystem-blocked',
+      summary: 'The test command did not start because the package manager could not write to its tool or cache ' +
+        'directory in this execution environment. No Test Optimization conclusion was reached.',
+      recommendation: 'Rerun with the project package manager already installed and a writable package-manager ' +
+        'home or cache directory. Do not interpret this launcher failure as a Test Optimization problem.',
+      signals: permissionLines,
+      blockedByExecutionEnvironment: true,
+    }
+  }
+}
+
+/**
+ * Returns a small de-duplicated set of matching output lines.
+ *
+ * @param {string} output command output
+ * @param {RegExp} pattern interesting-line pattern
+ * @returns {string[]} matching lines
+ */
+function getMatchingLines (output, pattern) {
+  const lines = []
+  const seen = new Set()
+  for (const line of output.split(/\r?\n/)) {
+    const value = line.trim()
+    if (!value || seen.has(value) || !pattern.test(value)) continue
+    seen.add(value)
+    lines.push(value)
+    if (lines.length === 6) break
+  }
+  return lines
+}
+
+module.exports = { getCommandBlocker }

package/ci/test-optimization-validation/command-output-policy.js

@@ -0,0 +1,206 @@
+'use strict'
+
+const fs = require('node:fs')
+const path = require('node:path')
+
+/**
+ * Returns command-created paths that must be declared and removed after validation.
+ *
+ * @param {object} command structured command
+ * @returns {string[]} absolute output paths
+ */
+function getCommandOutputPaths (command) {
+  const paths = new Set((command.outputPaths || []).map(outputPath => path.resolve(command.cwd, outputPath)))
+  const tokens = command.usesShell ? tokenizeShell(command.shellCommand) : command.argv || []
+  const coverageDirectory = getCoverageDirectory(tokens)
+  if (coverageDirectory) paths.add(path.resolve(command.cwd, coverageDirectory))
+  return [...paths]
+}
+
+/**
+ * Refuses pre-existing outputs and records parent identities for fail-closed cleanup.
+ *
+ * @param {object} input isolation inputs
+ * @param {object} input.command structured command
+ * @param {string} input.artifactRoot validation results root
+ * @param {string} [input.repositoryRoot] repository root
+ * @returns {{outputPath: string, repositoryRoot: string, parentIdentities: object[]}[]} cleanup state
+ */
+function prepareCommandOutputs ({ command, artifactRoot, repositoryRoot }) {
+  repositoryRoot = path.resolve(repositoryRoot || path.dirname(path.resolve(artifactRoot)))
+  const states = []
+  const outputPaths = getCommandOutputPaths(command)
+
+  for (const outputPath of outputPaths) {
+    assertSafeOutputPath({ outputPath, repositoryRoot, artifactRoot, command })
+  }
+  for (const outputPath of outputPaths) {
+    if (pathExists(outputPath)) {
+      throw new Error(
+        `Command output path already exists and will not be moved or overwritten: ${outputPath}. ` +
+        'Remove it or choose a command that writes to a fresh output path, then render a new approval plan.'
+      )
+    }
+    states.push({
+      outputPath,
+      repositoryRoot,
+      parentIdentities: captureExistingParentIdentities(outputPath, repositoryRoot),
+    })
+  }
+
+  return states
+}
+
+/**
+ * Removes outputs created by a command after revalidating every parent component.
+ *
+ * @param {{outputPath: string, repositoryRoot: string, parentIdentities: object[]}[]} states cleanup state
+ * @returns {object[]} customer-safe cleanup summary
+ */
+function cleanupCommandOutputs (states) {
+  const actions = []
+  for (let index = states.length - 1; index >= 0; index--) {
+    const state = states[index]
+    assertOutputParentsUnchanged(state)
+    const existed = fs.existsSync(state.outputPath)
+    if (existed) fs.rmSync(state.outputPath, { force: true, recursive: true })
+    actions.push({ outputPath: state.outputPath, action: existed ? 'removed' : 'absent' })
+  }
+  return actions.reverse()
+}
+
+/**
+ * Records every existing directory from repository.root through an output parent.
+ *
+ * @param {string} outputPath output path
+ * @param {string} repositoryRoot repository root
+ * @returns {{path: string, dev: number, ino: number}[]} parent identities
+ */
+function captureExistingParentIdentities (outputPath, repositoryRoot) {
+  const identities = []
+  const relative = path.relative(repositoryRoot, path.dirname(outputPath))
+  let current = repositoryRoot
+  for (const segment of relative ? relative.split(path.sep) : []) {
+    const stat = fs.lstatSync(current)
+    assertRegularDirectory(stat, current)
+    identities.push({ path: current, dev: stat.dev, ino: stat.ino })
+    current = path.join(current, segment)
+    if (!pathExists(current)) return identities
+  }
+
+  const stat = fs.lstatSync(current)
+  assertRegularDirectory(stat, current)
+  identities.push({ path: current, dev: stat.dev, ino: stat.ino })
+  return identities
+}
+
+/**
+ * Refuses cleanup if an existing parent changed or a new parent is a symbolic link.
+ *
+ * @param {object} state cleanup state
+ */
+function assertOutputParentsUnchanged (state) {
+  for (const identity of state.parentIdentities) {
+    const stat = fs.lstatSync(identity.path)
+    assertRegularDirectory(stat, identity.path)
+    if (stat.dev !== identity.dev || stat.ino !== identity.ino) {
+      throw new Error(`Refusing command output cleanup because a parent directory changed: ${identity.path}`)
+    }
+  }
+
+  const lastExisting = state.parentIdentities.at(-1).path
+  const relative = path.relative(lastExisting, path.dirname(state.outputPath))
+  let current = lastExisting
+  for (const segment of relative ? relative.split(path.sep) : []) {
+    current = path.join(current, segment)
+    if (!pathExists(current)) break
+    assertRegularDirectory(fs.lstatSync(current), current)
+  }
+}
+
+/**
+ * Refuses symbolic links and non-directory parent components.
+ *
+ * @param {fs.Stats} stat path status
+ * @param {string} directory directory path
+ */
+function assertRegularDirectory (stat, directory) {
+  if (!stat.isDirectory() || stat.isSymbolicLink()) {
+    throw new Error(`Refusing command output cleanup through a non-regular directory: ${directory}`)
+  }
+}
+
+function pathExists (filename) {
+  try {
+    fs.lstatSync(filename)
+    return true
+  } catch (error) {
+    if (error.code === 'ENOENT') return false
+    throw error
+  }
+}
+
+function getCoverageDirectory (tokens) {
+  let coverageEnabled = false
+  for (let index = 0; index < tokens.length; index++) {
+    const token = String(tokens[index])
+    if (token === '--coverage' || token === '--coverage=true') coverageEnabled = true
+    const inline = /^(?:--coverageDirectory|--coverage-directory|--coverage\.reportsDirectory)=(.+)$/.exec(token)
+    if (inline) return inline[1]
+    if (['--coverageDirectory', '--coverage-directory', '--coverage.reportsDirectory'].includes(token)) {
+      return tokens[index + 1]
+    }
+  }
+  return coverageEnabled ? 'coverage' : undefined
+}
+
+function tokenizeShell (source) {
+  return String(source || '').match(/"[^"]*"|'[^']*'|[^\s]+/g)?.map(token => {
+    return token.replace(/^(?:"([\s\S]*)"|'([\s\S]*)')$/, '$1$2')
+  }) || []
+}
+
+function assertSafeOutputPath ({ outputPath, repositoryRoot, artifactRoot, command }) {
+  const relative = path.relative(repositoryRoot, outputPath)
+  if (!relative || relative.startsWith('..') || path.isAbsolute(relative)) {
+    throw new Error(`Command output path must be a child of repository.root: ${outputPath}`)
+  }
+  assertPhysicalOutputPathInsideRepository(outputPath, repositoryRoot)
+  if (isPathInside(artifactRoot, outputPath) || isPathInside(outputPath, artifactRoot)) {
+    throw new Error(`Command output path must not contain or overlap validation artifacts: ${outputPath}`)
+  }
+  if (path.resolve(command.cwd) === outputPath) {
+    throw new Error(`Command output path must not replace the command working directory: ${outputPath}`)
+  }
+}
+
+/**
+ * Rejects an output whose nearest existing ancestor resolves outside the repository.
+ *
+ * @param {string} outputPath absolute output path
+ * @param {string} repositoryRoot absolute repository root
+ * @returns {void}
+ */
+function assertPhysicalOutputPathInsideRepository (outputPath, repositoryRoot) {
+  const physicalRoot = fs.realpathSync(repositoryRoot)
+  let existingPath = outputPath
+  while (!fs.existsSync(existingPath) && path.dirname(existingPath) !== existingPath) {
+    existingPath = path.dirname(existingPath)
+  }
+
+  const physicalExistingPath = fs.realpathSync(existingPath)
+  if (!isPathInside(physicalRoot, physicalExistingPath)) {
+    throw new Error(`Command output path must not resolve outside physical repository.root: ${outputPath}`)
+  }
+}
+
+function isPathInside (directory, filename) {
+  const relative = path.relative(path.resolve(directory), path.resolve(filename))
+  return relative === '' || (!relative.startsWith('..') && !path.isAbsolute(relative))
+}
+
+module.exports = {
+  cleanupCommandOutputs,
+  getCommandOutputPaths,
+  prepareCommandOutputs,
+}