dd-trace 6.8.0 → 6.10.0

package/packages/datadog-instrumentations/src/vitest-util.js

@@ -1,6 +1,12 @@
 'use strict'
 
+const fs = require('node:fs')
+
 const log = require('../../dd-trace/src/log')
+const {
+  EMPTY_EFD_RETRY_POLICY,
+  hasEfdRetries,
+} = require('../../dd-trace/src/ci-visibility/efd-retry-policy')
 const { channel } = require('./helpers/instrument')
 
 // test hooks
@@ -23,14 +29,32 @@ const testSessionFinishCh = channel('ci:vitest:session:finish')
 const testSessionConfigurationCh = channel('ci:vitest:session:configuration')
 const libraryConfigurationCh = channel('ci:vitest:library-configuration')
 const knownTestsCh = channel('ci:vitest:known-tests')
-const isEarlyFlakeDetectionFaultyCh = channel('ci:vitest:is-early-flake-detection-faulty')
 const testManagementTestsCh = channel('ci:vitest:test-management-tests')
 const modifiedFilesCh = channel('ci:vitest:modified-files')
 
+const CLOSING_SCRIPT_TAG_RE = /<\/script/i
+const SERIALIZED_CONTEXT_PREFIX = '\u0000dd-vitest-context:'
+
 const workerReportTraceCh = channel('ci:vitest:worker-report:trace')
+const workerReportCoverageCh = channel('ci:vitest:worker-report:coverage')
 const workerReportLogsCh = channel('ci:vitest:worker-report:logs')
+const workerReportTelemetryCh = channel('ci:vitest:worker-report:telemetry')
 const codeCoverageReportCh = channel('ci:vitest:coverage-report')
 
+/**
+ * Resolves a path without failing Test Optimization when the path is unavailable.
+ *
+ * @param {string} filepath
+ * @returns {string}
+ */
+function realpath (filepath) {
+  try {
+    return fs.realpathSync(filepath)
+  } catch {
+    return filepath
+  }
+}
+
 function findExportByName (pkg, name) {
   for (const [key, value] of Object.entries(pkg)) {
     if (value?.name === name) {
@@ -83,20 +107,73 @@ function getWorkspaceProject (ctx) {
 
 function setProvidedContext (ctx, values, warningMessage) {
   try {
-    Object.assign(getWorkspaceProject(ctx)._provided, values)
+    const providedContext = getWorkspaceProject(ctx)._provided
+    for (const key of Object.keys(values)) {
+      providedContext[key] = key.startsWith('_dd')
+        ? makeProvidedContextBrowserSafe(values[key])
+        : values[key]
+    }
   } catch {
     log.warn(warningMessage)
   }
 }
 
+/**
+ * Prevent Vitest Browser Mode from terminating its inline bootstrap script with Datadog metadata.
+ *
+ * @param {unknown} value
+ * @returns {unknown}
+ */
+function makeProvidedContextBrowserSafe (value) {
+  if (typeof value !== 'string' && (typeof value !== 'object' || value === null)) return value
+  if (typeof value === 'string' && !CLOSING_SCRIPT_TAG_RE.test(value)) return value
+
+  const serializedValue = JSON.stringify(value)
+  return CLOSING_SCRIPT_TAG_RE.test(serializedValue)
+    ? SERIALIZED_CONTEXT_PREFIX + serializedValue.replaceAll('<', String.raw`\u003c`)
+    : value
+}
+
+/**
+ * Restore context serialized by makeProvidedContextBrowserSafe.
+ *
+ * @param {unknown} value
+ * @returns {unknown}
+ */
+function parseProvidedContextValue (value) {
+  if (typeof value !== 'string' || !value.startsWith(SERIALIZED_CONTEXT_PREFIX)) return value
+
+  let parsedValue
+  try {
+    parsedValue = JSON.parse(value.slice(SERIALIZED_CONTEXT_PREFIX.length))
+  } catch {}
+  return parsedValue
+}
+
+/**
+ * Restores Datadog context values serialized for Vitest Browser Mode.
+ *
+ * @param {Record<string, unknown>} values
+ * @returns {Record<string, unknown>}
+ */
+function parseProvidedContextValues (values) {
+  const parsedValues = {}
+  for (const key of Object.keys(values)) {
+    if (key.startsWith('_dd')) {
+      parsedValues[key] = parseProvidedContextValue(values[key])
+    }
+  }
+  return parsedValues
+}
+
 function getProvidedContext () {
   try {
     const {
       _ddIsEarlyFlakeDetectionEnabled,
+      _ddIsEfdSuiteAdmissionEnabled: isEfdSuiteAdmissionEnabled,
       _ddIsDiEnabled,
-      _ddTestPropertiesByFilepath: testPropertiesByFilepath,
-      _ddEarlyFlakeDetectionNumRetries: numRepeats,
-      _ddEarlyFlakeDetectionSlowTestRetries: slowTestRetries,
+      _ddTestPropertiesByFilepath,
+      _ddEarlyFlakeDetectionRetryPolicy: earlyFlakeDetectionRetryPolicy,
       _ddIsKnownTestsEnabled: isKnownTestsEnabled,
       _ddIsTestManagementTestsEnabled: isTestManagementTestsEnabled,
       _ddTestManagementAttemptToFixRetries: testManagementAttemptToFixRetries,
@@ -110,14 +187,20 @@ function getProvidedContext () {
       _ddTestCommand: testCommand,
       _ddRepositoryRoot: repositoryRoot,
       _ddCodeOwnersEntries: codeOwnersEntries,
-    } = globalThis.__vitest_worker__.providedContext
+      _ddIsCodeCoverageEnabled: isCodeCoverageEnabled,
+      _ddItrCorrelationId: itrCorrelationId,
+      _ddUnskippableSuites: unskippableSuites,
+      _ddForcedToRunSuites: forcedToRunSuites,
+    } = parseProvidedContextValues(globalThis.__vitest_worker__.providedContext)
+    const retryPolicy = earlyFlakeDetectionRetryPolicy ?? EMPTY_EFD_RETRY_POLICY
+    const testPropertiesByFilepath = _ddTestPropertiesByFilepath || {}
 
     return {
       isDiEnabled: _ddIsDiEnabled,
-      isEarlyFlakeDetectionEnabled: _ddIsEarlyFlakeDetectionEnabled,
+      isEfdSuiteAdmissionEnabled,
+      isEarlyFlakeDetectionEnabled: _ddIsEarlyFlakeDetectionEnabled && hasEfdRetries(retryPolicy),
       testPropertiesByFilepath,
-      numRepeats,
-      slowTestRetries: slowTestRetries ?? {},
+      earlyFlakeDetectionRetryPolicy: retryPolicy,
       isKnownTestsEnabled,
       isTestManagementTestsEnabled,
       testManagementAttemptToFixRetries,
@@ -131,15 +214,19 @@ function getProvidedContext () {
       testCommand,
       repositoryRoot,
       codeOwnersEntries,
+      isCodeCoverageEnabled,
+      itrCorrelationId,
+      unskippableSuites,
+      forcedToRunSuites,
     }
   } catch {
     log.error('Vitest workers could not parse provided context, so some features will not work.')
     return {
       isDiEnabled: false,
+      isEfdSuiteAdmissionEnabled: false,
       isEarlyFlakeDetectionEnabled: false,
       testPropertiesByFilepath: {},
-      numRepeats: 0,
-      slowTestRetries: {},
+      earlyFlakeDetectionRetryPolicy: EMPTY_EFD_RETRY_POLICY,
       isKnownTestsEnabled: false,
       isTestManagementTestsEnabled: false,
       testManagementAttemptToFixRetries: 0,
@@ -153,6 +240,10 @@ function getProvidedContext () {
       testCommand: undefined,
       repositoryRoot: undefined,
       codeOwnersEntries: undefined,
+      isCodeCoverageEnabled: false,
+      itrCorrelationId: undefined,
+      unskippableSuites: {},
+      forcedToRunSuites: {},
     }
   }
 }
@@ -226,18 +317,21 @@ module.exports = {
   testSessionConfigurationCh,
   libraryConfigurationCh,
   knownTestsCh,
-  isEarlyFlakeDetectionFaultyCh,
   testManagementTestsCh,
   modifiedFilesCh,
   workerReportTraceCh,
+  workerReportCoverageCh,
   workerReportLogsCh,
+  workerReportTelemetryCh,
   codeCoverageReportCh,
+  realpath,
   findExportByName,
   getTestRunnerExport,
   getTypeTasks,
   getTestName,
   getWorkspaceProject,
   setProvidedContext,
+  parseProvidedContextValue,
   getProvidedContext,
   isFlakyTestRetriesEnabledForTask,
   getVitestTestProperties,