fix: make sure latest vitest versions get properly instrumented (#6773)

Author: juan-fernandez

integration-tests/vitest/vitest.spec.js

@@ -53,6 +53,7 @@ const {
   DD_CAPABILITIES_IMPACTED_TESTS
 } = require('../../packages/dd-trace/src/plugins/util/test')
 const { DD_HOST_CPU_COUNT } = require('../../packages/dd-trace/src/plugins/util/env')
+const { NODE_MAJOR } = require('../../version')
 
 const NUM_RETRIES_EFD = 3
 
@@ -399,7 +400,10 @@ versions.forEach((version) => {
     })
 
     // total code coverage only works for >=2.0.0
-    if (version === 'latest') {
+    // v4 dropped support for Node 18. Every test but this once passes, so we'll leave them
+    // for now. The breaking change is in https://github.com/vitest-dev/vitest/commit/9a0bf2254
+    // shipped in https://github.com/vitest-dev/vitest/releases/tag/v4.0.0-beta.12
+    if (version === 'latest' && NODE_MAJOR >= 20) {
       const coverageProviders = ['v8', 'istanbul']
 
       coverageProviders.forEach((coverageProvider) => {

packages/datadog-instrumentations/src/vitest.js

@@ -153,6 +153,10 @@ function isCliApiPackage (vitestPackage) {
   return vitestPackage.s?.name === 'startVitest'
 }
 
+function isTestPackage (testPackage) {
+  return testPackage.V?.name === 'VitestTestRunner'
+}
+
 function getSessionStatus (state) {
   if (state.getCountOfFailedTests() > 0) {
     return 'fail'
@@ -240,7 +244,9 @@ function getSortWrapper (sort, frameworkVersion) {
     if (isFlakyTestRetriesEnabled && !this.ctx.config.retry && flakyTestRetriesCount > 0) {
       this.ctx.config.retry = flakyTestRetriesCount
       try {
-        const workspaceProject = this.ctx.getCoreWorkspaceProject()
+        const workspaceProject = this.ctx.getCoreWorkspaceProject
+          ? this.ctx.getCoreWorkspaceProject()
+          : this.ctx.getRootProject()
         workspaceProject._provided._ddIsFlakyTestRetriesEnabled = isFlakyTestRetriesEnabled
       } catch {
         log.warn('Could not send library configuration to workers.')
@@ -272,7 +278,9 @@ function getSortWrapper (sort, frameworkVersion) {
             // TODO: use this to pass session and module IDs to the worker, instead of polluting process.env
             // Note: setting this.ctx.config.provide directly does not work because it's cached
             try {
-              const workspaceProject = this.ctx.getCoreWorkspaceProject()
+              const workspaceProject = this.ctx.getCoreWorkspaceProject
+                ? this.ctx.getCoreWorkspaceProject()
+                : this.ctx.getRootProject()
               workspaceProject._provided._ddIsKnownTestsEnabled = isKnownTestsEnabled
               workspaceProject._provided._ddKnownTests = knownTests
               workspaceProject._provided._ddIsEarlyFlakeDetectionEnabled = isEarlyFlakeDetectionEnabled
@@ -290,7 +298,9 @@ function getSortWrapper (sort, frameworkVersion) {
 
     if (isDiEnabled) {
       try {
-        const workspaceProject = this.ctx.getCoreWorkspaceProject()
+        const workspaceProject = this.ctx.getCoreWorkspaceProject
+          ? this.ctx.getCoreWorkspaceProject()
+          : this.ctx.getRootProject()
         workspaceProject._provided._ddIsDiEnabled = isDiEnabled
       } catch {
         log.warn('Could not send Dynamic Instrumentation configuration to workers.')
@@ -305,7 +315,9 @@ function getSortWrapper (sort, frameworkVersion) {
       } else {
         const testManagementTests = receivedTestManagementTests
         try {
-          const workspaceProject = this.ctx.getCoreWorkspaceProject()
+          const workspaceProject = this.ctx.getCoreWorkspaceProject
+            ? this.ctx.getCoreWorkspaceProject()
+            : this.ctx.getRootProject()
           workspaceProject._provided._ddIsTestManagementTestsEnabled = isTestManagementTestsEnabled
           workspaceProject._provided._ddTestManagementAttemptToFixRetries = testManagementAttemptToFixRetries
           workspaceProject._provided._ddTestManagementTests = testManagementTests
@@ -321,7 +333,9 @@ function getSortWrapper (sort, frameworkVersion) {
         log.error('Could not get modified tests.')
       } else {
         try {
-          const workspaceProject = this.ctx.getCoreWorkspaceProject()
+          const workspaceProject = this.ctx.getCoreWorkspaceProject
+            ? this.ctx.getCoreWorkspaceProject()
+            : this.ctx.getRootProject()
           workspaceProject._provided._ddIsImpactedTestsEnabled = isImpactedTestsEnabled
           workspaceProject._provided._ddModifiedFiles = modifiedFiles
         } catch {
@@ -443,13 +457,7 @@ function getStartVitestWrapper (cliApiPackage, frameworkVersion) {
   return cliApiPackage
 }
 
-addHook({
-  name: 'vitest',
-  versions: ['>=1.6.0'],
-  file: 'dist/runners.js'
-}, (vitestPackage) => {
-  const { VitestTestRunner } = vitestPackage
-
+function wrapVitestTestRunner (VitestTestRunner) {
   // `onBeforeRunTask` is run before any repetition or attempt is run
   // `onBeforeRunTask` is an async function
   shimmer.wrap(VitestTestRunner.prototype, 'onBeforeRunTask', onBeforeRunTask => function (task) {
@@ -744,6 +752,30 @@ addHook({
 
       return result
     })
+}
+
+addHook({
+  name: 'vitest',
+  versions: ['>=4.0.0'],
+  filePattern: 'dist/chunks/test.*'
+}, (testPackage) => {
+  if (!isTestPackage(testPackage)) {
+    return testPackage
+  }
+
+  wrapVitestTestRunner(testPackage.V)
+
+  return testPackage
+})
+
+addHook({
+  name: 'vitest',
+  versions: ['>=1.6.0 <4.0.0'],
+  file: 'dist/runners.js'
+}, (vitestPackage) => {
+  const { VitestTestRunner } = vitestPackage
+
+  wrapVitestTestRunner(VitestTestRunner)
 
   return vitestPackage
 })