dd-trace 5.124.0 → 5.126.0

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

@@ -1,5 +1,7 @@
 'use strict'
 
+const { AsyncResource } = require('node:async_hooks')
+
 const { createCoverageMap } = require('../../../../vendor/dist/istanbul-lib-coverage')
 const satisfies = require('../../../../vendor/dist/semifies')
 const { DD_MAJOR } = require('../../../../version')
@@ -35,6 +37,7 @@ const {
   isMarkedAsUnskippable,
 } = require('../../../dd-trace/src/plugins/util/test')
 
+const { addMochaRunHooks } = require('./common')
 const {
   isNewTest,
   getTestProperties,
@@ -60,8 +63,6 @@ const {
   adjustRunnerFailuresForTestOptimization,
 } = require('./utils')
 
-require('./common')
-
 const MINIMUM_MOCHA_VERSION = DD_MAJOR >= 6 ? '>=8.0.0' : '>=5.2.0'
 
 /**
@@ -81,6 +82,8 @@ const runnerTestEndHandlers = new WeakMap()
 const runnerFailuresAdjusted = new WeakSet()
 const runnerFrameworkErrors = new WeakMap()
 const runnerStarted = new WeakSet()
+const readyRunners = new WeakSet()
+const pendingRunnerStarts = new WeakMap()
 const runnerRecoveryStates = new WeakMap()
 const runnersWithPendingCoverageReset = new WeakSet()
 const parallelRunners = new WeakSet()
@@ -536,7 +539,10 @@ function stopCurrentHook (runner, hook) {
     if (test) {
       if (hook.parent?._afterEach?.includes(hook) || hook.parent?._afterAll?.includes(hook)) {
         markTestTerminal(runner, test)
-        if (!test._ddTestFinishStarted) runnerTestEndHandlers.get(runner)?.(test)
+        if (!test._ddTestFinishStarted) {
+          const onTestEnd = runnerTestEndHandlers.get(runner)
+          onTestEnd?.(test)
+        }
       } else {
         markTestPending(runner, test)
       }
@@ -763,14 +769,18 @@ function wrapRunnerEmit (Runner) {
             const test = hook.ctx?.currentTest
             if (test && hook.parent?._afterEach?.includes(hook)) {
               markTestTerminal(this, test)
-              if (!test._ddTestFinishStarted) runnerTestEndHandlers.get(this)?.(test)
+              if (!test._ddTestFinishStarted) {
+                const onTestEnd = runnerTestEndHandlers.get(this)
+                onTestEnd?.(test)
+              }
             }
           } else if (event === 'pending' || event === 'pass' || event === 'fail' || event === 'retry' ||
             event === 'test end') {
             const test = arguments[1]
             stopAfterEachHooks(this, test)
             if (event === 'test end' && !test._ddTestFinishStarted) {
-              runnerTestEndHandlers.get(this)?.(test)
+              const onTestEnd = runnerTestEndHandlers.get(this)
+              onTestEnd?.(test)
             }
           }
         }
@@ -1060,16 +1070,50 @@ function getExecutionConfiguration (runner, isParallel, frameworkVersion, onFini
   runStoresWithCompletion(libraryConfigurationCh, ctx, onReceivedConfiguration)
 }
 
+/**
+ * @param {import('mocha').Runner} runner
+ * @returns {void}
+ */
+function startMochaRunner (runner) {
+  if (readyRunners.has(runner)) {
+    runner.suite.run()
+  } else {
+    // Global setup can finish after configuration. Preserve the configuration
+    // context until Runner#run has installed its delayed-start listener.
+    pendingRunnerStarts.set(runner, AsyncResource.bind(() => runner.suite.run()))
+  }
+}
+
+/**
+ * @param {import('mocha').Runner['run']} run
+ * @param {import('mocha').Runner} runner
+ * @param {Parameters<import('mocha').Runner['run']>} args
+ * @returns {import('mocha').Runner}
+ */
+function runMochaRunner (run, runner, args) {
+  const result = run.apply(runner, args)
+  // Once delay mode is enabled, startup must complete even if the plugin is disabled during global setup.
+  readyRunners.add(runner)
+  const start = pendingRunnerStarts.get(runner)
+  if (start) {
+    pendingRunnerStarts.delete(runner)
+    start()
+  }
+  return result
+}
+
 // In this hook we delay the execution with options.delay to grab library configuration,
 // skippable and known tests.
 // It is called but skipped in parallel mode.
-addHook({
-  name: 'mocha',
-  versions: [MINIMUM_MOCHA_VERSION],
-  file: 'lib/mocha.js',
-}, (Mocha, frameworkVersion) => {
+/**
+ * @param {Function} Mocha
+ * @param {string} frameworkVersion
+ * @returns {Function}
+ */
+function wrapMochaRun (Mocha, frameworkVersion) {
   warnDeprecatedMochaVersion(frameworkVersion)
 
+  // Shimmer is required because run must return its Runner while execution is paused and resumed after configuration.
   shimmer.wrap(Mocha.prototype, 'run', run => function (...args) {
     // Workers do not need to request any data, just run the tests
     if (!testFinishCh.hasSubscribers || getEnvironmentVariable('MOCHA_WORKER_ID') || this.options.parallel) {
@@ -1110,23 +1154,25 @@ addHook({
         getCodeCoverageCh.publish({
           onDone: (receivedCodeCoverage) => {
             untestedCoverage = receivedCodeCoverage
-            global.run()
+            startMochaRunner(runner)
           },
         })
       } else {
-        global.run()
+        startMochaRunner(runner)
       }
     })
 
     return runner
   })
   return Mocha
-})
+}
+
+addMochaRunHooks([MINIMUM_MOCHA_VERSION], wrapMochaRun)
 
 addHook({
   name: 'mocha',
   versions: [MINIMUM_MOCHA_VERSION],
-  file: 'lib/cli/run-helpers.js',
+  filePattern: String.raw`lib/cli/run-helpers\.(?:c?js)$`,
 }, (run) => {
   // `runMocha` is an async function
   shimmer.wrap(run, 'runMocha', runMocha => function (...args) {
@@ -1136,7 +1182,7 @@ addHook({
     const mocha = args[0]
 
     /**
-     * This attaches `run` to the global context, which we'll call after
+     * This enables the delayed root suite, which we'll release after
      * our configuration and skippable suites requests.
      * You need this both here and in Mocha#run hook: the programmatic API
      * does not call `runMocha`, so it needs to be in Mocha#run. When using
@@ -1157,7 +1203,7 @@ addHook({
 addHook({
   name: 'mocha',
   versions: [MINIMUM_MOCHA_VERSION],
-  file: 'lib/runner.js',
+  filePattern: String.raw`lib/runner\.(?:c?js)$`,
 }, function (Runner, frameworkVersion) {
   if (patched.has(Runner)) return Runner
 
@@ -1168,7 +1214,7 @@ addHook({
 
   shimmer.wrap(Runner.prototype, 'run', run => function (...args) {
     if (!testFinishCh.hasSubscribers) {
-      return run.apply(this, args)
+      return runMochaRunner(run, this, args)
     }
 
     const { onRunDone, onFlushDone } = getRunCompletionCallbacks(args[0])
@@ -1501,7 +1547,7 @@ addHook({
       }
     })
 
-    return run.apply(this, args)
+    return runMochaRunner(run, this, args)
   })
 
   return Runner
@@ -1588,7 +1634,7 @@ addHook({
 addHook({
   name: 'mocha',
   versions: ['>=8.0.0'],
-  file: 'lib/nodejs/parallel-buffered-runner.js',
+  filePattern: String.raw`lib/nodejs/parallel-buffered-runner\.(?:c?js)$`,
 }, (ParallelBufferedRunner, frameworkVersion) => {
   shimmer.wrap(ParallelBufferedRunner.prototype, 'run', run => function (cb, { files, options = {} }) {
     if (!testFinishCh.hasSubscribers) {
@@ -1667,7 +1713,7 @@ addHook({
 addHook({
   name: 'mocha',
   versions: ['>=8.0.0'],
-  file: 'lib/nodejs/buffered-worker-pool.js',
+  filePattern: String.raw`lib/nodejs/buffered-worker-pool\.(?:c?js)$`,
 }, (BufferedWorkerPoolPackage, frameworkVersion) => {
   const { BufferedWorkerPool } = BufferedWorkerPoolPackage
 

package/packages/datadog-instrumentations/src/mocha/utils.js

@@ -507,7 +507,8 @@ function inheritDatadogPropertiesFromRetriedTest (test) {
 }
 
 function runnableWrapper (RunnablePackage, libraryConfig) {
-  shimmer.wrap(RunnablePackage.prototype, 'run', run => function (...args) {
+  const Runnable = RunnablePackage.Runnable ?? RunnablePackage
+  shimmer.wrap(Runnable.prototype, 'run', run => function (...args) {
     if (!testFinishCh.hasSubscribers) {
       return run.apply(this, args)
     }

package/packages/datadog-instrumentations/src/mocha/webdriverio-protocol.js

@@ -6,6 +6,11 @@ const {
   WEBDRIVERIO_WORKER_EVENT,
   WEBDRIVERIO_WORKER_ORIGIN,
 } = require('../../../dd-trace/src/ci-visibility/exporters/test-worker/webdriverio')
+const { FINAL_FLUSH_TIMEOUT } = require('../../../dd-trace/src/ci-visibility/final-flush')
+
+const SCREENSHOT_UPLOAD = 'dd:test-optimization:webdriverio:screenshot:upload'
+const SCREENSHOT_UPLOAD_RESPONSE = 'dd:test-optimization:webdriverio:screenshot:upload:response'
+const SCREENSHOT_UPLOAD_TIMEOUT_MS = FINAL_FLUSH_TIMEOUT + 5000
 
 /**
  * Sends a message over WebdriverIO's worker IPC envelope.
@@ -30,10 +35,103 @@ function sendWebdriverioWorkerMessage (message, onError, onDone) {
   })
 }
 
+let screenshotUploadRequestId = 0
+const screenshotUploadRequests = new Map()
+
+/**
+ * Removes shared screenshot response listeners when there are no pending requests.
+ *
+ * @returns {void}
+ */
+function removeScreenshotUploadListeners () {
+  if (screenshotUploadRequests.size !== 0) return
+
+  process.off('message', onScreenshotUploadResponse)
+  process.off('disconnect', onScreenshotUploadDisconnect)
+}
+
+/**
+ * Completes one pending screenshot upload request.
+ *
+ * @param {string} requestId
+ * @param {Error} [error]
+ * @returns {void}
+ */
+function finishScreenshotUploadRequest (requestId, error) {
+  const request = screenshotUploadRequests.get(requestId)
+  if (!request) return
+
+  screenshotUploadRequests.delete(requestId)
+  clearTimeout(request.timeout)
+  removeScreenshotUploadListeners()
+  request.onDone(error)
+}
+
+/**
+ * Dispatches one coordinator screenshot response to its pending request.
+ *
+ * @param {object} message
+ * @returns {void}
+ */
+function onScreenshotUploadResponse (message) {
+  if (message?.name !== SCREENSHOT_UPLOAD_RESPONSE) return
+
+  const { error: errorMessage, requestId } = message.content || {}
+  if (!requestId) return
+
+  finishScreenshotUploadRequest(requestId, errorMessage ? new Error(errorMessage) : undefined)
+}
+
+/**
+ * Fails every pending screenshot upload after coordinator disconnect.
+ *
+ * @returns {void}
+ */
+function onScreenshotUploadDisconnect () {
+  for (const requestId of screenshotUploadRequests.keys()) {
+    finishScreenshotUploadRequest(
+      requestId,
+      new Error('WebdriverIO coordinator disconnected during screenshot upload')
+    )
+  }
+}
+
+/**
+ * Requests one screenshot upload from the WebdriverIO coordinator.
+ *
+ * @param {object} content - Screenshot upload metadata
+ * @param {(error?: Error) => void} onDone - Upload completion callback
+ * @returns {void}
+ */
+function requestWebdriverioScreenshotUpload (content, onDone) {
+  const requestId = `${process.pid}-${++screenshotUploadRequestId}`
+  const timeout = setTimeout(() => {
+    finishScreenshotUploadRequest(requestId, new Error('WebdriverIO screenshot upload timed out'))
+  }, SCREENSHOT_UPLOAD_TIMEOUT_MS)
+  timeout.unref?.()
+  if (screenshotUploadRequests.size === 0) {
+    process.on('message', onScreenshotUploadResponse)
+    process.once('disconnect', onScreenshotUploadDisconnect)
+  }
+  screenshotUploadRequests.set(requestId, { onDone, timeout })
+  sendWebdriverioWorkerMessage({
+    origin: 'datadog',
+    name: SCREENSHOT_UPLOAD,
+    content: { ...content, requestId },
+  }, error => finishScreenshotUploadRequest(
+    requestId,
+    error || new Error('WebdriverIO screenshot upload IPC failed')
+  ))
+}
+
 module.exports = {
   CONFIGURATION_REQUEST: 'dd:test-optimization:webdriverio:configuration:request',
   CONFIGURATION_RESPONSE: 'dd:test-optimization:webdriverio:configuration:response',
   createWebdriverioWorkerMessage,
+  requestWebdriverioScreenshotUpload,
+  SCREENSHOT_UPLOAD,
+  SCREENSHOT_UPLOAD_RESPONSE,
+  SCREENSHOT_UPLOAD_TIMEOUT_MS,
   sendWebdriverioWorkerMessage,
   SUITE_FINISH: 'dd:test-optimization:webdriverio:test-suite:finish',
   WORKER_READY: 'dd:test-optimization:webdriverio:worker:ready',

package/packages/datadog-instrumentations/src/mocha/worker.js

@@ -7,6 +7,7 @@ const { getEnvironmentVariable } = require('../../../dd-trace/src/config/helper'
 const log = require('../../../dd-trace/src/log')
 const { DD_MAJOR } = require('../../../../version')
 
+const { addMochaRunHooks } = require('./common')
 const {
   runnableWrapper,
   getOnTestHandler,
@@ -29,7 +30,6 @@ const {
   WEBDRIVERIO_WORKER_ENV,
   WORKER_READY,
 } = require('./webdriverio-protocol')
-require('./common')
 
 const MINIMUM_MOCHA_VERSION = DD_MAJOR >= 6 ? '>=8.0.0' : '>=5.2.0'
 
@@ -360,13 +360,15 @@ function isFailedTestReplayEnabled () {
   return config.isTestDynamicInstrumentationEnabled && config.isDiEnabled
 }
 
-addHook({
-  name: 'mocha',
-  versions: ['>=8.0.0'],
-  file: 'lib/mocha.js',
-}, (Mocha, frameworkVersion) => {
+/**
+ * @param {Function} Mocha
+ * @param {string} frameworkVersion
+ * @returns {Function}
+ */
+function wrapMochaRun (Mocha, frameworkVersion) {
   reportWebdriverioWorkerReady(frameworkVersion)
 
+  // Shimmer is required because run must return its Runner while execution is paused and resumed after configuration.
   shimmer.wrap(Mocha.prototype, 'run', run => function (...args) {
     applyMochaOptions(this.options)
     if (!isWebdriverioWorker || !workerFinishCh.hasSubscribers) {
@@ -438,13 +440,15 @@ addHook({
   })
 
   return Mocha
-})
+}
+
+addMochaRunHooks(['>=8.0.0'], wrapMochaRun)
 
 // Runner is also hooked in mocha/main.js, but in here we only generate test events.
 addHook({
   name: 'mocha',
   versions: [MINIMUM_MOCHA_VERSION],
-  file: 'lib/runner.js',
+  filePattern: String.raw`lib/runner\.(?:c?js)$`,
 }, function (Runner) {
   shimmer.wrap(Runner.prototype, 'runTests', runTests => getRunTestsWrapper(runTests, config))
 

package/packages/datadog-instrumentations/src/net.js

@@ -27,8 +27,6 @@ addHook({ name: 'net' }, (net) => {
     }
 
     const options = getOptions(args)
-    const lastIndex = args.length - 1
-    const callback = args[lastIndex]
 
     if (!options) return connect.apply(this, args)
 
@@ -38,42 +36,39 @@ addHook({ name: 'net' }, (net) => {
     const errorCh = protocol === 'ipc' ? errorICPCh : errorTCPCh
     const ctx = { options }
 
-    if (typeof callback === 'function') {
-      args[lastIndex] = function (...args) {
-        return finishCh.runStores(ctx, callback, this, ...args)
-      }
-    }
-
     return startCh.runStores(ctx, () => {
-      setupListeners(this, protocol, ctx, finishCh, errorCh)
+      const cleanup = setupListeners(this, protocol, ctx, finishCh, errorCh)
 
-      const emit = this.emit
+      const originalEmit = this.emit
       let pendingReadyEvents = 2
       // Named `emit`/arity-1 mirrors the socket method so the per-socket wrap
       // skips its name/length rewrite.
-      this.emit = shimmer.wrapFunction(emit, originalEmit => function emit (eventName) {
+      this.emit = shimmer.wrapFunction(originalEmit, wrappedEmit => function emit (eventName) {
         switch (eventName) {
           case 'ready':
           case 'connect':
             if (--pendingReadyEvents === 0) this.emit = originalEmit
             return readyCh.runStores(ctx, () => {
-              return Reflect.apply(originalEmit, this, arguments)
+              return Reflect.apply(wrappedEmit, this, arguments)
             })
           case 'error':
           case 'close':
             this.emit = originalEmit
-            return Reflect.apply(originalEmit, this, arguments)
+            return Reflect.apply(wrappedEmit, this, arguments)
           default:
-            return Reflect.apply(originalEmit, this, arguments)
+            return Reflect.apply(wrappedEmit, this, arguments)
         }
       })
 
       try {
         return connect.apply(this, args)
-      } catch (err) {
-        errorCh.publish(err)
+      } catch (error) {
+        cleanup()
+        this.emit = originalEmit
+        errorCh.publish(error)
+        finishCh.runStores(ctx, () => {})
 
-        throw err
+        throw error
       }
     })
   })
@@ -142,4 +137,6 @@ function setupListeners (socket, protocol, ctx, finishCh, errorCh) {
   for (const event of events) {
     socket.once(event, wrapListener)
   }
+
+  return cleanupOtherListeners
 }