dd-trace 6.7.0 → 6.8.0

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

@@ -1,5 +1,6 @@
 'use strict'
 
+const fs = require('node:fs')
 const path = require('node:path')
 const { fileURLToPath } = require('node:url')
 const { MessagePort } = require('node:worker_threads')
@@ -67,6 +68,7 @@ let coverageRootDir
 let requestErrorTags = {}
 let isSessionStarted = false
 let isVitestNoWorkerInitActive = false
+let isVitestBrowserModeActive = false
 let vitestPool = null
 let isMessagePortWrapped = false
 const tinyPoolClassWrappers = new WeakMap()
@@ -197,7 +199,21 @@ function getTestFilepaths (ctx, testSpecifications) {
  */
 function getNormalizedTestSuitePath (testFilepath, repositoryRoot) {
   const testSuiteAbsolutePath = path.isAbsolute(testFilepath) ? testFilepath : path.join(repositoryRoot, testFilepath)
-  return getTestSuitePath(testSuiteAbsolutePath, repositoryRoot)
+  return getTestSuitePath(realpath(testSuiteAbsolutePath), realpath(repositoryRoot))
+}
+
+/**
+ * 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
+  }
 }
 
 /**
@@ -281,6 +297,10 @@ function getTestPropertiesByFilepath (
   for (const testFilepath of testFilepaths) {
     if (typeof testFilepath !== 'string') continue
 
+    const testSuiteAbsolutePath = path.isAbsolute(testFilepath)
+      ? testFilepath
+      : path.join(repositoryRoot, testFilepath)
+    const realTestFilepath = realpath(testSuiteAbsolutePath)
     const testSuite = getNormalizedTestSuitePath(testFilepath, repositoryRoot)
     const testProperties = { testSuite }
     const hasProperties = knownTestsBySuite !== undefined ||
@@ -299,6 +319,8 @@ function getTestPropertiesByFilepath (
 
     if (hasProperties) {
       testPropertiesByFilepath[testFilepath] = testProperties
+      testPropertiesByFilepath[testSuiteAbsolutePath] = testProperties
+      testPropertiesByFilepath[realTestFilepath] = testProperties
     }
   }
 
@@ -405,11 +427,18 @@ function mergeRequestErrorTags (requestResponse) {
   }
 }
 
-async function runMainProcessSetup (ctx, frameworkVersion, testSpecifications, shouldInstallNoWorkerInit) {
+async function runMainProcessSetup (
+  ctx,
+  frameworkVersion,
+  testSpecifications,
+  shouldInstallNoWorkerInit,
+  shouldInstallBrowserReporter
+) {
   if (!testSessionFinishCh.hasSubscribers) {
     return
   }
 
+  isVitestBrowserModeActive ||= shouldInstallBrowserReporter
   let repositoryRoot = process.cwd()
   let testSessionConfiguration
   let testFilepaths
@@ -435,7 +464,7 @@ async function runMainProcessSetup (ctx, frameworkVersion, testSpecifications, s
       requestErrorTags: receivedRequestErrorTags = {},
     } = await getChannelPromise(libraryConfigurationCh, {
       frameworkVersion,
-      isVitestNoWorkerInitActive: shouldInstallNoWorkerInit,
+      isVitestNoWorkerInitActive: shouldInstallNoWorkerInit || isVitestBrowserModeActive,
     })
     requestErrorTags = receivedRequestErrorTags
     if (err) {
@@ -459,7 +488,11 @@ async function runMainProcessSetup (ctx, frameworkVersion, testSpecifications, s
       repositoryRoot: receivedRepositoryRoot,
       codeOwnersEntries,
     } = testSessionConfiguration
-    repositoryRoot = receivedRepositoryRoot || repositoryRoot
+    repositoryRoot = realpath(receivedRepositoryRoot || repositoryRoot)
+    testSessionConfiguration = {
+      ...testSessionConfiguration,
+      repositoryRoot,
+    }
     if (!shouldInstallNoWorkerInit) {
       setProvidedContext(ctx, {
         _ddTestSessionId: testSessionId,
@@ -589,8 +622,11 @@ async function runMainProcessSetup (ctx, frameworkVersion, testSpecifications, s
     }
   }
 
-  if (shouldInstallNoWorkerInit) {
-    noWorkerInit.configure(ctx, frameworkVersion, testSpecifications, {
+  if (shouldInstallNoWorkerInit || shouldInstallBrowserReporter) {
+    const reporterTestSpecifications = shouldInstallNoWorkerInit
+      ? testSpecifications
+      : getBrowserTestSpecifications(testSpecifications)
+    noWorkerInit.configure(ctx, frameworkVersion, reporterTestSpecifications, {
       knownTests,
       knownTestsBySuite,
       modifiedFiles,
@@ -602,6 +638,7 @@ async function runMainProcessSetup (ctx, frameworkVersion, testSpecifications, s
       testSessionConfiguration,
     }, {
       getConfiguredEfdRetryCount,
+      shouldReportTestModule: shouldInstallBrowserReporter ? isBrowserTestModule : undefined,
       state: getNoWorkerInitState(),
     })
   }
@@ -628,18 +665,29 @@ function getNoWorkerInitState () {
 
 function ensureMainProcessSetup (ctx, frameworkVersion, testSpecifications, shouldDeactivateOnFallback = false) {
   const shouldInstallNoWorkerInit = shouldUseNoWorkerInit(ctx, frameworkVersion, testSpecifications)
+  const shouldInstallBrowserReporter = shouldUseBrowserReporter(frameworkVersion, testSpecifications)
+  const shouldInstallMainReporter = shouldInstallNoWorkerInit || shouldInstallBrowserReporter
   const specificationsKey = getTestSpecificationsKey(testSpecifications)
   let setupState = mainProcessSetupStates.get(ctx)
-  if (shouldDeactivateOnFallback && setupState?.shouldInstallNoWorkerInit && !shouldInstallNoWorkerInit) {
+  if (shouldDeactivateOnFallback && setupState?.shouldInstallMainReporter && !shouldInstallMainReporter) {
     noWorkerInit.deactivate(ctx)
   }
   if (
     !setupState ||
     setupState.specificationsKey !== specificationsKey ||
-    setupState.shouldInstallNoWorkerInit !== shouldInstallNoWorkerInit
+    setupState.shouldInstallNoWorkerInit !== shouldInstallNoWorkerInit ||
+    setupState.shouldInstallBrowserReporter !== shouldInstallBrowserReporter
   ) {
     setupState = {
-      setupPromise: runMainProcessSetup(ctx, frameworkVersion, testSpecifications, shouldInstallNoWorkerInit),
+      setupPromise: runMainProcessSetup(
+        ctx,
+        frameworkVersion,
+        testSpecifications,
+        shouldInstallNoWorkerInit,
+        shouldInstallBrowserReporter
+      ),
+      shouldInstallBrowserReporter,
+      shouldInstallMainReporter,
       shouldInstallNoWorkerInit,
       specificationsKey,
     }
@@ -655,6 +703,12 @@ function shouldUseNoWorkerInit (ctx, frameworkVersion, testSpecifications) {
   })
 }
 
+function shouldUseBrowserReporter (frameworkVersion, testSpecifications) {
+  return noWorkerInit.isSupportedVersion(frameworkVersion) &&
+    Array.isArray(testSpecifications) &&
+    testSpecifications.some(isBrowserTestSpecification)
+}
+
 function configureFlakyTestRetries (ctx, testSpecifications) {
   if (!isFlakyTestRetriesEnabled || flakyTestRetriesCount <= 0) return
 
@@ -828,7 +882,7 @@ function getFinishWrapper (exitOrClose) {
       isTestManagementTestsEnabled,
       requestErrorTags,
       vitestPool,
-      isVitestNoWorkerInitActive,
+      isVitestNoWorkerInitActive: isVitestNoWorkerInitActive || isVitestBrowserModeActive,
     })
 
     logTestOptimizationSummary({ attemptToFixExecutions, newTestsWithDynamicNames })
@@ -869,6 +923,15 @@ function isVitestWorkerPool (pool) {
   return isForkPool(pool) || isThreadPool(pool)
 }
 
+function isBrowserProject (project) {
+  try {
+    if (project?.isBrowserEnabled?.()) return true
+  } catch {}
+
+  return safeConfig(project)?.browser?.enabled === true ||
+    project?.serializedConfig?.browser?.enabled === true
+}
+
 function getTestSpecificationProject (testSpecification) {
   if (Array.isArray(testSpecification)) {
     return testSpecification[0]
@@ -890,6 +953,23 @@ function getTestSpecificationPool (testSpecification) {
     testSpecification?.pool
 }
 
+function isBrowserTestSpecification (testSpecification) {
+  return getTestSpecificationPool(testSpecification) === 'browser' ||
+    isBrowserProject(getTestSpecificationProject(testSpecification))
+}
+
+function getBrowserTestSpecifications (testSpecifications) {
+  if (!Array.isArray(testSpecifications)) return testSpecifications
+
+  return testSpecifications.filter(isBrowserTestSpecification)
+}
+
+function isBrowserTestModule (testModule) {
+  return testModule?.task?.pool === 'browser' ||
+    testModule?.pool === 'browser' ||
+    isBrowserProject(testModule?.project)
+}
+
 function hasVitestWorkerPoolTestSpecification (testSpecifications) {
   if (!Array.isArray(testSpecifications)) {
     return false