fix: step by step reporter for run-workers (taken from codeceptjs#5083)

Author: William Gorge

lib/plugin/stepByStepReport.js

@@ -40,6 +40,18 @@ const templates = {}
  * npx codeceptjs run --plugins stepByStepReport
  * ```
  *
+ * Run tests with workers:
+ *
+ * ```
+ * npx codeceptjs run-workers 2 --plugins stepByStepReport
+ * ```
+ *
+ * Run tests with multiple configurations:
+ *
+ * ```
+ * npx codeceptjs run-multiple --all --plugins stepByStepReport
+ * ```
+ *
  * #### Configuration
  *
  * ```js
@@ -60,6 +72,20 @@ const templates = {}
  * * `screenshotsForAllureReport`: If Allure plugin is enabled this plugin attaches each saved screenshot to allure report. Default: false.
  * * `disableScreenshotOnFail : Disables the capturing of screeshots after the failed step. Default: true.
  *
+ * #### Worker and Multiple Run Support
+ *
+ * When using `run-workers`, `run-multiple`, or combinations thereof, the plugin automatically
+ * detects all worker and run processes and creates a consolidated step-by-step report that
+ * includes screenshots from all processes while keeping them in their original directories.
+ *
+ * Screenshots remain in their respective process directories for traceability:
+ * - **run-workers**: Screenshots saved in `/output/worker1/`, `/output/worker2/`, etc.
+ * - **run-multiple**: Screenshots saved in `/output/config_name_hash/`, etc.
+ * - **Mixed scenarios**: Screenshots saved in `/output/config_name_hash/worker1/`, etc.
+ *
+ * The final consolidated report links to all screenshots while preserving their original locations
+ * and indicating which process or worker they came from.
+ *
  * @param {*} config
  */
 
@@ -87,8 +113,12 @@ module.exports = function (config) {
 
   const recordedTests = {}
   const pad = '0000'
+
   const reportDir = config.output ? path.resolve(global.codecept_dir, config.output) : defaultConfig.output
 
+  // Ensure the report directory exists
+  mkdirp.sync(reportDir)
+
   event.dispatcher.on(event.suite.before, suite => {
     stepNum = -1
   })
@@ -137,11 +167,70 @@ module.exports = function (config) {
 
   event.dispatcher.on(event.workers.result, async () => {
     await recorder.add(() => {
-      const recordedTests = getRecordFoldersWithDetails(reportDir)
+      // For workers and run-multiple scenarios, we need to search across multiple directories
+      // to find all screenshot folders from different processes
+      const recordedTests = getRecordFoldersFromAllDirectories()
       generateRecordsHtml(recordedTests)
     })
   })
 
+  function getRecordFoldersFromAllDirectories() {
+    let results = {}
+
+    // Determine the base output directory to search from
+    const baseOutputDir = config.output ? path.resolve(global.codecept_dir, config.output) : defaultConfig.output
+
+    // Function to recursively search for record folders in a directory
+    function searchForRecordFolders(searchDir, basePath = '') {
+      try {
+        if (!fs.existsSync(searchDir)) return
+
+        const items = fs.readdirSync(searchDir, { withFileTypes: true })
+
+        items.forEach(item => {
+          if (item.isDirectory()) {
+            const itemPath = path.join(searchDir, item.name)
+            const relativePath = basePath ? path.join(basePath, item.name) : item.name
+
+            // If this is a record folder, process it
+            if (item.name.startsWith('record_')) {
+              const indexPath = path.join(itemPath, 'index.html')
+
+              let name = ''
+              if (fs.existsSync(indexPath)) {
+                try {
+                  const htmlContent = fs.readFileSync(indexPath, 'utf-8')
+                  const $ = cheerio.load(htmlContent)
+                  name = $('.navbar-brand').text().trim()
+                } catch (err) {
+                  console.error(`Error reading index.html in ${itemPath}:`, err.message)
+                }
+              }
+
+              // Include the relative path to show which process/worker this came from
+              const displayName = basePath ? `${name} (${basePath})` : name
+              results[displayName || 'Unknown'] = path.join(relativePath, 'index.html')
+            } else {
+              // Continue searching in subdirectories (worker folders, run-multiple folders)
+              searchForRecordFolders(itemPath, relativePath)
+            }
+          }
+        })
+      } catch (err) {
+        console.error(`Error searching directory ${searchDir}:`, err.message)
+      }
+    }
+
+    // Start the search from the base output directory
+    searchForRecordFolders(baseOutputDir)
+
+    // Also check the current reportDir for backwards compatibility
+    const currentDirResults = getRecordFoldersWithDetails(reportDir)
+    Object.assign(results, currentDirResults)
+
+    return results
+  }
+
   function getRecordFoldersWithDetails(dirPath) {
     let results = {}
 
@@ -186,9 +275,32 @@ module.exports = function (config) {
       records: links,
     })
 
-    fs.writeFileSync(path.join(reportDir, 'records.html'), indexHTML)
+    // Determine where to write the main records.html file
+    // For worker/run-multiple scenarios, we want to write to the base output directory
+    let recordsHtmlDir = reportDir
+
+    if (global.codecept_dir && (process.env.RUNS_WITH_WORKERS === 'true' || process.argv.some(arg => arg === '--child'))) {
+      // Extract base output directory by removing worker/run-specific segments
+      const baseOutputDir = config.output ? path.resolve(global.codecept_dir, config.output) : defaultConfig.output
+      let actualBaseDir = baseOutputDir
+
+      // For workers: strip worker directory segment
+      if (process.env.RUNS_WITH_WORKERS === 'true') {
+        actualBaseDir = actualBaseDir.replace(/[/\\][^/\\]+$/, '')
+      }
+
+      // For run-multiple: strip run directory segment
+      if (process.argv.some(arg => arg === '--child')) {
+        actualBaseDir = actualBaseDir.replace(/[/\\][^/\\]+$/, '')
+      }
+
+      recordsHtmlDir = actualBaseDir
+      mkdirp.sync(recordsHtmlDir)
+    }
+
+    fs.writeFileSync(path.join(recordsHtmlDir, 'records.html'), indexHTML)
 
-    output.print(`${figures.circleFilled} Step-by-step preview: ${colors.white.bold(`file://${reportDir}/records.html`)}`)
+    output.print(`${figures.circleFilled} Step-by-step preview: ${colors.white.bold(`file://${recordsHtmlDir}/records.html`)}`)
   }
 
   async function persistStep(step) {