[test optimization] Fix test suite error handling in jest (#6913)

Author: juan-fernandez

integration-tests/ci-visibility/jest-bad-import/jest-bad-import-test.js

@@ -1,5 +1,9 @@
 'use strict'
 
 it('will fail', () => {
-  import('./off-timing-import.js')
+  setTimeout(() => {
+    const sum = require('./off-timing-import.js')
+
+    expect(sum(1, 2)).toBe(3)
+  }, 0)
 })

integration-tests/ci-visibility/jest-bad-import/off-timing-import.js

@@ -1,5 +1,5 @@
 'use strict'
 
-module.exports = {
-  sum: (a, b) => a + b
+module.exports = function sum (a, b) {
+  return a + b
 }

integration-tests/ci-visibility/run-jest.js

@@ -41,6 +41,10 @@ if (process.env.DO_NOT_INJECT_GLOBALS) {
   options.injectGlobals = false
 }
 
+if (process.env.WAIT_FOR_UNHANDLED_REJECTIONS) {
+  options.waitForUnhandledRejections = true
+}
+
 jest.runCLI(
   options,
   options.projects

integration-tests/jest/jest.spec.js

@@ -1008,36 +1008,36 @@ describe(`jest@${JEST_VERSION} commonJS`, () => {
   })
 
   context('when using off timing imports', () => {
-    onlyLatestIt('reports test suite errors when using off timing import', async () => {
+    onlyLatestIt('reports test suite errors when waitForUnhandledRejections=true', async () => {
       const eventsPromise = receiver
         .gatherPayloadsMaxTimeout(({ url }) => url.endsWith('/api/v2/citestcycle'), (payloads) => {
           const events = payloads.flatMap(({ payload }) => payload.events)
           const suites = events.filter(event => event.type === 'test_suite_end')
-          assert.equal(suites.length, 6)
+          assert.equal(suites.length, 3)
+
           const failedTestSuites = suites.filter(
             suite => suite.content.meta[TEST_SUITE] === 'ci-visibility/jest-bad-import/jest-bad-import-test.js'
           )
-          assert.equal(failedTestSuites.length, 4)
-          failedTestSuites.forEach(suite => {
-            assert.equal(suite.content.meta[TEST_STATUS], 'fail')
-            assert.include(suite.content.meta[ERROR_MESSAGE], 'a file outside of the scope of the test code')
-            assert.equal(suite.content.meta[ERROR_TYPE], 'ReferenceError')
-          })
+          assert.equal(failedTestSuites.length, 1)
+          const [failedTestSuite] = failedTestSuites
+
+          assert.equal(failedTestSuite.content.meta[TEST_STATUS], 'fail')
+          assert.include(failedTestSuite.content.meta[ERROR_MESSAGE], 'a file outside of the scope of the test code')
+          assert.equal(failedTestSuite.content.meta[ERROR_TYPE], 'Error')
+
           const passedTestSuites = suites.filter(
             suite => suite.content.meta[TEST_STATUS] === 'pass'
           )
           assert.equal(passedTestSuites.length, 2)
         })
 
-      const { NODE_OPTIONS, ...restEnvVars } = getCiVisAgentlessConfig(receiver.port)
       childProcess = exec(runTestsCommand, {
         cwd,
         env: {
-          ...restEnvVars,
-          // need --experimental-vm-modules to trigger the error
-          NODE_OPTIONS: `${NODE_OPTIONS} --experimental-vm-modules`,
+          ...getCiVisAgentlessConfig(receiver.port),
           TESTS_TO_RUN: 'jest-bad-import/jest-bad-import-test',
           RUN_IN_PARALLEL: true,
+          WAIT_FOR_UNHANDLED_REJECTIONS: true
         },
         stdio: 'inherit'
       })

packages/datadog-instrumentations/src/jest.js

@@ -1345,9 +1345,6 @@ addHook({
         }
       }
       return returnedValue
-    } catch (error) {
-      testSuiteErrorCh.publish({ error, testSuiteAbsolutePath: this._testPath })
-      throw error
     } finally {
       // Restore original prepareStackTrace
       Error.prepareStackTrace = originalPrepareStackTrace