dd-trace 6.7.0 → 6.8.0

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

@@ -0,0 +1,914 @@
+'use strict'
+
+const { AsyncResource } = require('node:async_hooks')
+const { fileURLToPath } = require('node:url')
+
+const { getEnvironmentVariable } = require('../../dd-trace/src/config/helper')
+const log = require('../../dd-trace/src/log')
+const {
+  collectTestOptimizationSummariesFromTraces,
+  getIsFaultyEarlyFlakeDetection,
+  getTestSuitePath,
+  logTestOptimizationSummary,
+  MOCHA_WORKER_LOGS_PAYLOAD_CODE,
+  MOCHA_WORKER_TRACE_PAYLOAD_CODE,
+  TEST_SUITE_EXECUTION_ID,
+} = require('../../dd-trace/src/plugins/util/test')
+const { addHook, channel, tracingChannel } = require('./helpers/instrument')
+const {
+  CONFIGURATION_REQUEST,
+  CONFIGURATION_RESPONSE,
+  SUITE_FINISH,
+  WEBDRIVERIO_WORKER_ENV,
+  WEBDRIVERIO_WORKER_EVENT,
+  WEBDRIVERIO_WORKER_ORIGIN,
+  WORKER_READY,
+} = require('./mocha/webdriverio-protocol')
+
+const testFinishCh = channel('ci:mocha:test:finish')
+const testSessionStartCh = channel('ci:mocha:session:start')
+const testSessionFinishCh = channel('ci:mocha:session:finish')
+const testSuiteStartCh = channel('ci:mocha:test-suite:start')
+const testSuiteFinishCh = channel('ci:mocha:test-suite:finish')
+const knownTestsCh = channel('ci:mocha:known-tests')
+const libraryConfigurationCh = channel('ci:mocha:library-configuration')
+const modifiedFilesCh = channel('ci:mocha:modified-files')
+const testManagementTestsCh = channel('ci:mocha:test-management-tests')
+const workerReportLogsCh = channel('ci:mocha:worker-report:logs')
+const workerReportTraceCh = channel('ci:mocha:worker-report:trace')
+
+const launcherStartInstanceCh = tracingChannel('orchestrion:@wdio/cli:Launcher_startInstance')
+const localRunnerRunCh = tracingChannel('orchestrion:@wdio/local-runner:LocalRunner_run')
+const localRunnerShutdownCh = tracingChannel('orchestrion:@wdio/local-runner:LocalRunner_shutdown')
+
+const NODE_OPTIONS_SEPARATOR_RE = /\s/
+const TEST_FRAMEWORK = 'webdriverio'
+
+const loadCh = channel('dd-trace:instrumentation:load')
+if (loadCh.hasSubscribers) {
+  loadCh.publish({ name: '@wdio/local-runner' })
+}
+
+const coordinatorStates = new WeakMap()
+const localRunnerVersions = new WeakMap()
+
+addHook({
+  name: '@wdio/local-runner',
+  versions: ['>=9.0.0'],
+  file: 'build/index.js',
+  patchDefault: true,
+}, (LocalRunner, version) => {
+  localRunnerVersions.set(LocalRunner, version)
+  return LocalRunner
+})
+
+/**
+ * @typedef {object} WebdriverioRunnerConfig
+ * @property {string} framework
+ * @property {string|undefined} rootDir
+ * @property {NodeJS.ProcessEnv|undefined} runnerEnv
+ */
+
+/**
+ * @typedef {object} WebdriverioLocalRunner
+ * @property {WebdriverioRunnerConfig|undefined} config
+ * @property {WebdriverioRunnerConfig|undefined} _config
+ */
+
+/**
+ * @typedef {object} WorkerRecord
+ * @property {object} worker
+ * @property {string[]} specs
+ * @property {Map<string, WebdriverioSuiteContext>} suiteContexts
+ * @property {string} testSuiteExecutionId
+ * @property {boolean|undefined} hasTests
+ * @property {number|undefined} exitCode
+ * @property {number|undefined} retries
+ */
+
+/**
+ * @typedef {object} WebdriverioSuiteContext
+ * @property {object|undefined} currentStore
+ * @property {string|undefined} status
+ * @property {string} testSuiteAbsolutePath
+ * @property {string} testSuiteExecutionId
+ */
+
+/**
+ * @typedef {object} CoordinatorState
+ * @property {WebdriverioLocalRunner} localRunner
+ * @property {AsyncResource} asyncResource
+ * @property {object} configuration
+ * @property {boolean} initialized
+ * @property {boolean} initializing
+ * @property {Array<(configuration: object) => void>} initializationCallbacks
+ * @property {boolean} sessionStarted
+ * @property {boolean} finished
+ * @property {string|undefined} frameworkVersion
+ * @property {string} testFrameworkAdapter
+ * @property {number} activeWorkers
+ * @property {Map<string, object>} attemptToFixExecutions
+ * @property {number} maxActiveWorkers
+ * @property {Set<string>} newTestsWithDynamicNames
+ * @property {number} nextWorkerId
+ * @property {Set<string>} scheduledFiles
+ * @property {unknown} runError
+ * @property {Set<WorkerRecord>} workers
+ * @property {Map<object, string>} suiteStatuses
+ */
+
+/**
+ * Creates the configuration consumed by Mocha workers.
+ *
+ * @returns {object}
+ */
+function createWorkerConfiguration () {
+  return {
+    earlyFlakeDetectionFaultyThreshold: 30,
+    earlyFlakeDetectionNumRetries: 0,
+    earlyFlakeDetectionSlowTestRetries: {},
+    flakyTestRetriesCount: 0,
+    isCodeCoverageEnabled: false,
+    isCoverageReportUploadEnabled: false,
+    isDiEnabled: false,
+    isEarlyFlakeDetectionEnabled: false,
+    isFlakyTestRetriesEnabled: false,
+    isImpactedTestsEnabled: false,
+    isItrEnabled: false,
+    isKnownTestsEnabled: false,
+    isSuitesSkippingEnabled: false,
+    isTestDynamicInstrumentationEnabled: false,
+    isTestManagementTestsEnabled: false,
+    knownTests: {},
+    modifiedFiles: [],
+    repositoryRoot: undefined,
+    testFramework: TEST_FRAMEWORK,
+    testManagementAttemptToFixRetries: 0,
+    testManagementTests: {},
+  }
+}
+
+/**
+ * Gets the public runner configuration, or the private equivalent used by older releases.
+ *
+ * @param {WebdriverioLocalRunner} localRunner
+ * @returns {WebdriverioRunnerConfig|undefined}
+ */
+function getRunnerConfiguration (localRunner) {
+  return localRunner.config || localRunner._config
+}
+
+/**
+ * Gets or creates coordinator state for a WebdriverIO local runner.
+ *
+ * @param {WebdriverioLocalRunner} localRunner
+ * @returns {CoordinatorState}
+ */
+function getCoordinatorState (localRunner) {
+  let state = coordinatorStates.get(localRunner)
+  if (state) {
+    return state
+  }
+
+  state = {
+    localRunner,
+    asyncResource: new AsyncResource('dd-trace-webdriverio-coordinator'),
+    configuration: createWorkerConfiguration(),
+    initialized: false,
+    initializing: false,
+    initializationCallbacks: [],
+    sessionStarted: false,
+    finished: false,
+    frameworkVersion: localRunnerVersions.get(localRunner.constructor),
+    testFrameworkAdapter: getRunnerConfiguration(localRunner)?.framework,
+    activeWorkers: 0,
+    attemptToFixExecutions: new Map(),
+    maxActiveWorkers: 0,
+    newTestsWithDynamicNames: new Set(),
+    nextWorkerId: 0,
+    scheduledFiles: new Set(),
+    runError: undefined,
+    workers: new Set(),
+    suiteStatuses: new Map(),
+  }
+  coordinatorStates.set(localRunner, state)
+
+  return state
+}
+
+/**
+ * Normalizes a WebdriverIO spec identifier to a filesystem path.
+ *
+ * @param {string} file
+ * @returns {string}
+ */
+function normalizeFile (file) {
+  return file.startsWith('file://') ? fileURLToPath(file) : file
+}
+
+/**
+ * Adds resolved WebdriverIO spec files to the coordinator's complete schedule.
+ *
+ * @param {CoordinatorState} state
+ * @param {string[]} files
+ * @returns {void}
+ */
+function addScheduledFiles (state, files) {
+  for (const file of files) {
+    state.scheduledFiles.add(normalizeFile(file))
+  }
+}
+
+/**
+ * Checks whether worker NODE_OPTIONS contain the complete launcher options.
+ *
+ * @param {string|undefined} workerNodeOptions
+ * @param {string} launcherNodeOptions
+ * @returns {boolean}
+ */
+function includesNodeOptions (workerNodeOptions, launcherNodeOptions) {
+  if (!workerNodeOptions) {
+    return false
+  }
+
+  let index = workerNodeOptions.indexOf(launcherNodeOptions)
+  while (index !== -1) {
+    const endIndex = index + launcherNodeOptions.length
+    const startsAtBoundary = index === 0 || NODE_OPTIONS_SEPARATOR_RE.test(workerNodeOptions[index - 1])
+    const endsAtBoundary = endIndex === workerNodeOptions.length ||
+      NODE_OPTIONS_SEPARATOR_RE.test(workerNodeOptions[endIndex])
+
+    if (startsAtBoundary && endsAtBoundary) {
+      return true
+    }
+    index = workerNodeOptions.indexOf(launcherNodeOptions, index + 1)
+  }
+  return false
+}
+
+/**
+ * Starts the single Mocha session owned by the WebdriverIO launcher.
+ *
+ * @param {CoordinatorState} state
+ * @returns {void}
+ */
+function startSession (state) {
+  if (state.sessionStarted) {
+    return
+  }
+  const processArgv = process.argv.slice(2).join(' ')
+  const command = processArgv ? `wdio ${processArgv}` : 'wdio'
+  const rootDir = getRunnerConfiguration(state.localRunner)?.rootDir || process.cwd()
+
+  testSessionStartCh.publish({
+    command,
+    frameworkVersion: state.frameworkVersion,
+    rootDir,
+    testFramework: TEST_FRAMEWORK,
+    testFrameworkAdapter: state.testFrameworkAdapter,
+  })
+  state.sessionStarted = true
+}
+
+/**
+ * Completes coordinator initialization and releases waiting workers.
+ *
+ * @param {CoordinatorState} state
+ * @returns {void}
+ */
+function completeCoordinatorInitialization (state) {
+  if (state.initialized) {
+    return
+  }
+
+  state.initialized = true
+  state.initializing = false
+  startSession(state)
+
+  const callbacks = state.initializationCallbacks
+  state.initializationCallbacks = []
+  for (const callback of callbacks) {
+    callback(state.configuration)
+  }
+}
+
+/**
+ * Runs one coordinator-owned feature request.
+ *
+ * @param {CoordinatorState} state
+ * @param {import('node:diagnostics_channel').Channel} requestChannel
+ * @param {(response: object) => void} onDone
+ * @returns {void}
+ */
+function requestCoordinatorData (state, requestChannel, onDone) {
+  if (!requestChannel.hasSubscribers) {
+    onDone({ err: new Error('Test optimization was not initialized correctly') })
+    return
+  }
+
+  try {
+    requestChannel.runStores({
+      onDone: response => state.asyncResource.runInAsyncScope(onDone, undefined, response),
+    }, () => {})
+  } catch (error) {
+    log.error('WebdriverIO Test Optimization feature request error', error)
+    onDone({ err: error })
+  }
+}
+
+/**
+ * Maps backend framework data to the Mocha adapter's internal framework key.
+ *
+ * @param {object|undefined} frameworkData
+ * @returns {object|undefined}
+ */
+function getMochaFrameworkData (frameworkData) {
+  return frameworkData?.[TEST_FRAMEWORK] ?? frameworkData?.mocha
+}
+
+/**
+ * Applies settings and requests the enabled non-TIA datasets once for the whole run.
+ *
+ * @param {CoordinatorState} state
+ * @param {object|undefined} response
+ * @returns {void}
+ */
+function configureCoordinator (state, response) {
+  const { configuration } = state
+  const {
+    err,
+    isTestDynamicInstrumentationEnabled,
+    libraryConfig,
+    repositoryRoot,
+  } = response || {}
+
+  configuration.repositoryRoot = repositoryRoot
+  if (err || !libraryConfig) {
+    completeCoordinatorInitialization(state)
+    return
+  }
+
+  configuration.earlyFlakeDetectionFaultyThreshold = libraryConfig.earlyFlakeDetectionFaultyThreshold
+  configuration.earlyFlakeDetectionNumRetries = libraryConfig.earlyFlakeDetectionNumRetries
+  configuration.earlyFlakeDetectionSlowTestRetries = libraryConfig.earlyFlakeDetectionSlowTestRetries ?? {}
+  configuration.flakyTestRetriesCount = libraryConfig.flakyTestRetriesCount
+  configuration.isDiEnabled = libraryConfig.isDiEnabled
+  configuration.isEarlyFlakeDetectionEnabled = libraryConfig.isEarlyFlakeDetectionEnabled
+  configuration.isFlakyTestRetriesEnabled = libraryConfig.isFlakyTestRetriesEnabled
+  configuration.isImpactedTestsEnabled = libraryConfig.isImpactedTestsEnabled
+  configuration.isKnownTestsEnabled = libraryConfig.isKnownTestsEnabled
+  configuration.isTestDynamicInstrumentationEnabled = isTestDynamicInstrumentationEnabled
+  configuration.isTestManagementTestsEnabled = libraryConfig.isTestManagementEnabled
+  configuration.testManagementAttemptToFixRetries = libraryConfig.testManagementAttemptToFixRetries
+
+  let pendingRequests = 1
+
+  /**
+   * Completes initialization after all enabled requests settle.
+   *
+   * @returns {void}
+   */
+  function finishRequest () {
+    pendingRequests--
+    if (pendingRequests === 0) {
+      completeCoordinatorInitialization(state)
+    }
+  }
+
+  if (configuration.isKnownTestsEnabled) {
+    pendingRequests++
+    requestCoordinatorData(state, knownTestsCh, ({ err, knownTests } = {}) => {
+      const mochaKnownTests = getMochaFrameworkData(knownTests)
+      if (err || !mochaKnownTests) {
+        configuration.isEarlyFlakeDetectionEnabled = false
+        configuration.isKnownTestsEnabled = false
+      } else {
+        configuration.knownTests = { mocha: mochaKnownTests }
+      }
+      finishRequest()
+    })
+  }
+
+  if (configuration.isTestManagementTestsEnabled) {
+    pendingRequests++
+    requestCoordinatorData(state, testManagementTestsCh, ({ err, testManagementTests } = {}) => {
+      if (err) {
+        configuration.isTestManagementTestsEnabled = false
+        configuration.testManagementAttemptToFixRetries = 0
+      } else {
+        const mochaTestManagementTests = getMochaFrameworkData(testManagementTests) || { suites: {} }
+        configuration.testManagementTests = { mocha: mochaTestManagementTests }
+      }
+      finishRequest()
+    })
+  }
+
+  if (configuration.isImpactedTestsEnabled) {
+    pendingRequests++
+    requestCoordinatorData(state, modifiedFilesCh, ({ err, modifiedFiles } = {}) => {
+      if (err) {
+        configuration.isImpactedTestsEnabled = false
+      } else {
+        configuration.modifiedFiles = modifiedFiles
+      }
+      finishRequest()
+    })
+  }
+
+  finishRequest()
+}
+
+/**
+ * Requests settings once so the launcher owns initialization for every worker.
+ *
+ * @param {CoordinatorState} state
+ * @param {(configuration: object) => void} [onDone]
+ * @returns {void}
+ */
+function initializeCoordinator (state, onDone) {
+  if (state.initialized) {
+    onDone?.(state.configuration)
+    return
+  }
+  if (onDone) {
+    state.initializationCallbacks.push(onDone)
+  }
+  if (state.initializing) {
+    return
+  }
+
+  state.initializing = true
+  if (!libraryConfigurationCh.hasSubscribers) {
+    completeCoordinatorInitialization(state)
+    return
+  }
+
+  try {
+    libraryConfigurationCh.runStores({
+      disableTestImpactAnalysis: true,
+      frameworkVersion: state.frameworkVersion,
+      isParallel: state.maxActiveWorkers > 1,
+      testFramework: TEST_FRAMEWORK,
+      onDone: response => state.asyncResource.runInAsyncScope(
+        configureCoordinator,
+        undefined,
+        state,
+        response
+      ),
+    }, () => {})
+  } catch (error) {
+    log.error('WebdriverIO Test Optimization configuration error', error)
+    completeCoordinatorInitialization(state)
+  }
+}
+
+/**
+ * Starts suites for one worker.
+ *
+ * @param {WorkerRecord} workerRecord
+ * @param {string[]} files
+ * @returns {void}
+ */
+function startWorkerSuites (workerRecord, files) {
+  for (const rawFile of files) {
+    const file = normalizeFile(rawFile)
+    if (workerRecord.suiteContexts.has(file)) {
+      continue
+    }
+
+    const suiteContext = {
+      testSuiteAbsolutePath: file,
+      testSuiteExecutionId: workerRecord.testSuiteExecutionId,
+    }
+    testSuiteStartCh.runStores(suiteContext, () => {})
+    workerRecord.suiteContexts.set(file, suiteContext)
+  }
+}
+
+/**
+ * Finishes one suite if it is still active.
+ *
+ * @param {CoordinatorState} state
+ * @param {WorkerRecord} workerRecord
+ * @param {string} rawFile
+ * @param {string} status
+ * @returns {void}
+ */
+function finishWorkerSuite (state, workerRecord, rawFile, status) {
+  const file = normalizeFile(rawFile)
+  const suiteContext = workerRecord.suiteContexts.get(file)
+  if (!suiteContext || state.suiteStatuses.has(suiteContext)) {
+    return
+  }
+
+  state.suiteStatuses.set(suiteContext, status)
+  testSuiteFinishCh.publish({ status, ...suiteContext.currentStore })
+}
+
+/**
+ * Finishes every active suite belonging to a worker.
+ *
+ * @param {CoordinatorState} state
+ * @param {WorkerRecord} workerRecord
+ * @param {string} status
+ * @returns {void}
+ */
+function finishAllWorkerSuites (state, workerRecord, status) {
+  let hasFailedSuite = false
+  for (const suiteContext of workerRecord.suiteContexts.values()) {
+    if (suiteContext.status === 'fail') {
+      hasFailedSuite = true
+      break
+    }
+  }
+
+  for (const [file, suiteContext] of workerRecord.suiteContexts) {
+    let suiteStatus = suiteContext.status ?? status
+    if (status === 'fail' && !hasFailedSuite && suiteStatus === 'skip') {
+      suiteStatus = 'fail'
+    }
+    finishWorkerSuite(state, workerRecord, file, suiteStatus)
+  }
+}
+
+/**
+ * Sends a coordinator message to a WebdriverIO child process.
+ *
+ * @param {WorkerRecord} workerRecord
+ * @param {object} message
+ * @returns {void}
+ */
+function sendWorkerMessage (workerRecord, message) {
+  const childProcess = workerRecord.worker.childProcess
+  if (!childProcess?.connected) {
+    return
+  }
+
+  childProcess.send(message, (error) => {
+    if (error) {
+      log.error('WebdriverIO Test Optimization IPC error', error)
+    }
+  })
+}
+
+/**
+ * Handles a worker request for its Mocha execution configuration.
+ *
+ * @param {CoordinatorState} state
+ * @param {WorkerRecord} workerRecord
+ * @param {object} message
+ * @returns {void}
+ */
+function handleConfigurationRequest (state, workerRecord, message) {
+  const { files = [], requestId } = message.content || {}
+
+  initializeCoordinator(state, (configuration) => {
+    updateEarlyFlakeDetectionFaultyState(state, files)
+    startWorkerSuites(workerRecord, files)
+    sendWorkerMessage(workerRecord, {
+      origin: 'datadog',
+      name: CONFIGURATION_RESPONSE,
+      content: {
+        configuration,
+        requestId,
+      },
+    })
+  })
+}
+
+/**
+ * Disables EFD when the accumulated WebdriverIO run exceeds its new-suite threshold.
+ *
+ * @param {CoordinatorState} state
+ * @param {string[]} files
+ * @returns {void}
+ */
+function updateEarlyFlakeDetectionFaultyState (state, files) {
+  const { configuration } = state
+  if (!configuration.isKnownTestsEnabled) {
+    return
+  }
+
+  addScheduledFiles(state, files)
+  const scheduledSuites = []
+  for (const file of state.scheduledFiles) {
+    scheduledSuites.push(getTestSuitePath(file, process.cwd()))
+  }
+
+  const isFaulty = getIsFaultyEarlyFlakeDetection(
+    scheduledSuites,
+    configuration.knownTests?.mocha || {},
+    configuration.earlyFlakeDetectionFaultyThreshold
+  )
+  if (isFaulty) {
+    configuration.isEarlyFlakeDetectionEnabled = false
+    configuration.isEarlyFlakeDetectionFaulty = true
+    configuration.isKnownTestsEnabled = false
+  }
+}
+
+/**
+ * Handles suite results reported by a Mocha worker.
+ *
+ * @param {WorkerRecord} workerRecord
+ * @param {object} message
+ * @returns {void}
+ */
+function handleSuiteResults (workerRecord, message) {
+  const { results = [] } = message.content || {}
+  for (const { file, status } of results) {
+    const suiteContext = workerRecord.suiteContexts.get(normalizeFile(file))
+    if (suiteContext) {
+      suiteContext.status = status
+    }
+  }
+}
+
+/**
+ * Handles all messages emitted by one WebdriverIO child process.
+ *
+ * @param {CoordinatorState} state
+ * @param {WorkerRecord} workerRecord
+ * @param {object|unknown[]} message
+ * @returns {void}
+ */
+function handleWorkerMessage (state, workerRecord, message) {
+  if (message?.origin === WEBDRIVERIO_WORKER_ORIGIN && message.name === WEBDRIVERIO_WORKER_EVENT) {
+    message = message.args
+  }
+
+  if (Array.isArray(message)) {
+    const [messageCode, payload] = message
+    if (messageCode === MOCHA_WORKER_TRACE_PAYLOAD_CODE) {
+      collectTestOptimizationSummariesFromTraces(payload, {
+        attemptToFixExecutions: state.attemptToFixExecutions,
+        newTestsWithDynamicNames: state.newTestsWithDynamicNames,
+      })
+      workerReportTraceCh.publish({
+        traces: payload,
+        [TEST_SUITE_EXECUTION_ID]: workerRecord.testSuiteExecutionId,
+      })
+    } else if (messageCode === MOCHA_WORKER_LOGS_PAYLOAD_CODE) {
+      workerReportLogsCh.publish(payload)
+    }
+    return
+  }
+
+  if (!message || typeof message !== 'object') {
+    return
+  }
+
+  if (message.name === WORKER_READY) {
+    initializeCoordinator(state)
+    return
+  }
+  if (message.name === CONFIGURATION_REQUEST) {
+    handleConfigurationRequest(state, workerRecord, message)
+    return
+  }
+  if (message.name === SUITE_FINISH) {
+    handleSuiteResults(workerRecord, message)
+    return
+  }
+  if (message.name === 'testFrameworkInit') {
+    workerRecord.hasTests = message.content?.hasTests
+    if (!workerRecord.hasTests && state.frameworkVersion) {
+      initializeCoordinator(state, () => {
+        startWorkerSuites(workerRecord, workerRecord.specs)
+        finishAllWorkerSuites(state, workerRecord, 'skip')
+      })
+    }
+  }
+}
+
+/**
+ * Handles child-process exit and closes suites missing an explicit result.
+ *
+ * @param {CoordinatorState} state
+ * @param {WorkerRecord} workerRecord
+ * @param {object} exit
+ * @returns {void}
+ */
+function handleWorkerExit (state, workerRecord, exit) {
+  state.activeWorkers--
+  workerRecord.exitCode = exit.exitCode
+  workerRecord.retries = exit.retries
+  if (!state.sessionStarted) {
+    return
+  }
+
+  const status = workerRecord.hasTests === false ? 'skip' : exit.exitCode === 0 ? 'pass' : 'fail'
+  if (status === 'fail' && workerRecord.suiteContexts.size === 0) {
+    startWorkerSuites(workerRecord, workerRecord.specs)
+  }
+  finishAllWorkerSuites(state, workerRecord, status)
+}
+
+/**
+ * Registers a newly created WebdriverIO worker with the coordinator.
+ *
+ * @param {CoordinatorState} state
+ * @param {object} worker
+ * @param {string[]} specs
+ * @returns {void}
+ */
+function registerWorker (state, worker, specs) {
+  const normalizedSpecs = []
+  for (const spec of specs) {
+    normalizedSpecs.push(normalizeFile(spec))
+  }
+
+  const workerRecord = {
+    worker,
+    specs: normalizedSpecs,
+    suiteContexts: new Map(),
+    testSuiteExecutionId: String(++state.nextWorkerId),
+    hasTests: undefined,
+    exitCode: undefined,
+    retries: undefined,
+  }
+  state.activeWorkers++
+  if (state.activeWorkers > state.maxActiveWorkers) {
+    state.maxActiveWorkers = state.activeWorkers
+  }
+  state.workers.add(workerRecord)
+
+  worker.on('message', message => handleWorkerMessage(state, workerRecord, message))
+  worker.once('exit', exit => handleWorkerExit(state, workerRecord, exit))
+}
+
+/**
+ * Calculates the final status for the coordinated session.
+ *
+ * @param {CoordinatorState} state
+ * @returns {string}
+ */
+function getSessionStatus (state) {
+  let hasPassingSuite = false
+
+  for (const workerRecord of state.workers) {
+    if (workerRecord.exitCode !== undefined && workerRecord.exitCode !== 0) {
+      if (workerRecord.retries > 0) {
+        continue
+      }
+      return 'fail'
+    }
+    for (const suiteContext of workerRecord.suiteContexts.values()) {
+      const status = state.suiteStatuses.get(suiteContext)
+      if (status === 'fail') {
+        return 'fail'
+      }
+      if (status === 'pass') {
+        hasPassingSuite = true
+      }
+    }
+  }
+
+  return hasPassingSuite ? 'pass' : 'skip'
+}
+
+/**
+ * Finishes the single WebdriverIO-owned Mocha session.
+ *
+ * @param {CoordinatorState} state
+ * @param {unknown} error
+ * @param {() => void} onDone
+ * @returns {void}
+ */
+function finishCoordinator (state, error, onDone) {
+  if (state.finished) {
+    onDone()
+    return
+  }
+  if (!state.sessionStarted) {
+    if (!error && getSessionStatus(state) !== 'fail') {
+      onDone()
+      return
+    }
+    initializeCoordinator(state, () => finishCoordinator(state, error, onDone))
+    return
+  }
+  state.finished = true
+
+  for (const workerRecord of state.workers) {
+    const status = workerRecord.hasTests === false
+      ? 'skip'
+      : workerRecord.exitCode === 0 ? 'pass' : 'fail'
+    finishAllWorkerSuites(state, workerRecord, status)
+  }
+
+  if (!testSessionFinishCh.hasSubscribers) {
+    logTestOptimizationSummary({
+      attemptToFixExecutions: state.attemptToFixExecutions,
+      newTestsWithDynamicNames: state.newTestsWithDynamicNames,
+    })
+    onDone()
+    return
+  }
+
+  testSessionFinishCh.publish({
+    status: error ? 'fail' : getSessionStatus(state),
+    error,
+    isEarlyFlakeDetectionEnabled: state.configuration.isEarlyFlakeDetectionEnabled,
+    isEarlyFlakeDetectionFaulty: state.configuration.isEarlyFlakeDetectionFaulty,
+    isParallel: state.maxActiveWorkers > 1,
+    isSuitesSkipped: false,
+    isTestManagementEnabled: state.configuration.isTestManagementTestsEnabled,
+    onDone,
+  })
+  logTestOptimizationSummary({
+    attemptToFixExecutions: state.attemptToFixExecutions,
+    newTestsWithDynamicNames: state.newTestsWithDynamicNames,
+  })
+}
+
+// dc-polyfill supports partial tracing-channel subscribers, unlike the Node.js type definition.
+// @ts-expect-error
+launcherStartInstanceCh.subscribe({
+  start (context) {
+    const localRunner = context.self?.runner
+    const runnerConfiguration = localRunner && getRunnerConfiguration(localRunner)
+    if (!testFinishCh.hasSubscribers || runnerConfiguration?.framework !== 'mocha') {
+      return
+    }
+
+    const state = getCoordinatorState(localRunner)
+    addScheduledFiles(state, context.arguments?.[0] || [])
+    for (const schedule of context.self._schedule || []) {
+      for (const { files } of schedule.specs || []) {
+        addScheduledFiles(state, files)
+      }
+    }
+  },
+})
+
+// dc-polyfill supports partial tracing-channel subscribers, unlike the Node.js type definition.
+// @ts-expect-error
+localRunnerRunCh.subscribe({
+  start (context) {
+    const runnerConfiguration = getRunnerConfiguration(context.self)
+    if (!testFinishCh.hasSubscribers || runnerConfiguration?.framework !== 'mocha') {
+      return
+    }
+
+    const state = getCoordinatorState(context.self)
+    const workerOptions = context.arguments?.[0]
+    addScheduledFiles(state, workerOptions?.specs || [])
+    let workerEnvironment = runnerConfiguration.runnerEnv || {}
+    const launcherNodeOptions = getEnvironmentVariable('NODE_OPTIONS')
+    const workerNodeOptions = workerEnvironment.NODE_OPTIONS
+
+    if (launcherNodeOptions && !includesNodeOptions(workerNodeOptions, launcherNodeOptions)) {
+      workerEnvironment = {
+        ...workerEnvironment,
+        NODE_OPTIONS: workerNodeOptions
+          ? `${launcherNodeOptions} ${workerNodeOptions}`
+          : launcherNodeOptions,
+      }
+    }
+
+    runnerConfiguration.runnerEnv = {
+      ...workerEnvironment,
+      MOCHA_WORKER_ID: 'webdriverio',
+      [WEBDRIVERIO_WORKER_ENV]: 'true',
+    }
+    context.ddCoordinatorState = state
+    context.ddWorkerSpecs = workerOptions?.specs || []
+  },
+  asyncEnd (context) {
+    const state = context.ddCoordinatorState
+    if (!state) {
+      return
+    }
+    if (context.error) {
+      state.runError ??= context.error
+      return
+    }
+    if (!context.result) {
+      return
+    }
+    registerWorker(state, context.result, context.ddWorkerSpecs)
+  },
+})
+
+// @ts-expect-error See the partial tracing-channel subscriber above.
+localRunnerShutdownCh.subscribe({
+  asyncEnd (context) {
+    const state = coordinatorStates.get(context.self)
+    if (!state) {
+      return
+    }
+
+    // Orchestrion uses the callback for the matching settlement path to delay LocalRunner.shutdown.
+    const waitForCoordinator = onDone => {
+      const error = context.error ?? state.runError
+      if (state.initializing) {
+        state.initializationCallbacks.push(() => finishCoordinator(state, error, onDone))
+      } else {
+        finishCoordinator(state, error, onDone)
+      }
+    }
+    context.resolveCallback = waitForCoordinator
+    context.rejectCallback = waitForCoordinator
+  },
+})