codeceptjs 4.0.1-beta.3 → 4.0.1-beta.31

package/lib/step/meta.js

@@ -58,17 +58,24 @@ class MetaStep extends Step {
     this.status = 'queued'
     this.setArguments(Array.from(arguments).slice(1))
     let result
+    let hasChildSteps = false
 
     const registerStep = step => {
       this.setMetaStep(null)
       step.setMetaStep(this)
+      hasChildSteps = true
     }
     event.dispatcher.prependListener(event.step.before, registerStep)
+
+    // Start timing
+    this.startTime = Date.now()
+
     // Handle async and sync methods.
     if (fn.constructor.name === 'AsyncFunction') {
       result = fn
         .apply(this.context, this.args)
         .then(result => {
+          this.setStatus('success')
           return result
         })
         .catch(error => {
@@ -78,17 +85,27 @@ class MetaStep extends Step {
         .finally(() => {
           this.endTime = Date.now()
           event.dispatcher.removeListener(event.step.before, registerStep)
+          // Only emit events if no child steps were registered
+          if (!hasChildSteps) {
+            event.emit(event.step.started, this)
+            event.emit(event.step.finished, this)
+          }
         })
     } else {
       try {
-        this.startTime = Date.now()
         result = fn.apply(this.context, this.args)
+        this.setStatus('success')
       } catch (error) {
         this.setStatus('failed')
         throw error
       } finally {
         this.endTime = Date.now()
         event.dispatcher.removeListener(event.step.before, registerStep)
+        // Only emit events if no child steps were registered
+        if (!hasChildSteps) {
+          event.emit(event.step.started, this)
+          event.emit(event.step.finished, this)
+        }
       }
     }
 

package/lib/step/record.js

@@ -5,6 +5,7 @@ import output from '../output.js'
 import store from '../store.js'
 import { TIMEOUT_ORDER } from '../timeout.js'
 import retryStep from './retry.js'
+import { fixErrorStack } from '../utils/typescript.js'
 function recordStep(step, args) {
   step.status = 'queued'
 
@@ -60,6 +61,13 @@ function recordStep(step, args) {
   recorder.catch(err => {
     step.status = 'failed'
     step.endTime = +Date.now()
+    
+    // Fix error stack to point to original .ts files (lazy import to avoid circular dependency)
+    const fileMapping = global.container?.tsFileMapping?.()
+    if (fileMapping) {
+      fixErrorStack(err, fileMapping)
+    }
+    
     event.emit(event.step.failed, step, err)
     event.emit(event.step.finished, step)
     throw err

package/lib/utils/loaderCheck.js

@@ -65,9 +65,18 @@ CodeceptJS 4.x uses ES Modules (ESM) and requires a loader to run TypeScript tes
     ✅ Complete: Handles all TypeScript features
 
 ┌─────────────────────────────────────────────────────────────────────────────┐
-│ Option 2: ts-node/esm (Alternative - Established, Requires Config)         │
+│ Option 2: ts-node/esm (Not Recommended - Has Module Resolution Issues)     │
 └─────────────────────────────────────────────────────────────────────────────┘
 
+  ⚠️  ts-node/esm has significant limitations and is not recommended:
+      - Doesn't work with "type": "module" in package.json
+      - Module resolution doesn't work like standard TypeScript ESM
+      - Import statements must use explicit file paths
+  
+  We strongly recommend using tsx/cjs instead.
+  
+  If you still want to use ts-node/esm:
+
   Installation:
     npm install --save-dev ts-node
 
@@ -84,11 +93,12 @@ CodeceptJS 4.x uses ES Modules (ESM) and requires a loader to run TypeScript tes
            "esModuleInterop": true
          },
          "ts-node": {
-           "esm": true,
-           "experimentalSpecifierResolution": "node"
+           "esm": true
          }
        }
 
+    3. Do NOT use "type": "module" in package.json
+
 📚 Documentation: https://codecept.io/typescript
 
 Note: TypeScript config files (codecept.conf.ts) and helpers are automatically

package/lib/utils/typescript.js

@@ -4,10 +4,10 @@ import path from 'path'
 /**
  * Transpile TypeScript files to ES modules with CommonJS shim support
  * Handles recursive transpilation of imported TypeScript files
- * 
+ *
  * @param {string} mainFilePath - Path to the main TypeScript file to transpile
  * @param {object} typescript - TypeScript compiler instance
- * @returns {Promise<{tempFile: string, allTempFiles: string[]}>} - Main temp file and all temp files created
+ * @returns {Promise<{tempFile: string, allTempFiles: string[], fileMapping: any}>} - Main temp file and all temp files created
  */
 export async function transpileTypeScript(mainFilePath, typescript) {
   const { transpile } = typescript
@@ -18,7 +18,7 @@ export async function transpileTypeScript(mainFilePath, typescript) {
    */
   const transpileTS = (filePath) => {
     const tsContent = fs.readFileSync(filePath, 'utf8')
-    
+
     // Transpile TypeScript to JavaScript with ES module output
     let jsContent = transpile(tsContent, {
       module: 99, // ModuleKind.ESNext
@@ -29,16 +29,16 @@ export async function transpileTypeScript(mainFilePath, typescript) {
       suppressOutputPathCheck: true,
       skipLibCheck: true,
     })
-    
+
     // Check if the code uses CommonJS globals
     const usesCommonJSGlobals = /__dirname|__filename/.test(jsContent)
     const usesRequire = /\brequire\s*\(/.test(jsContent)
     const usesModuleExports = /\b(module\.exports|exports\.)/.test(jsContent)
-    
+
     if (usesCommonJSGlobals || usesRequire || usesModuleExports) {
       // Inject ESM equivalents at the top of the file
       let esmGlobals = ''
-      
+
       if (usesRequire || usesModuleExports) {
         // IMPORTANT: Use the original .ts file path as the base for require()
         // This ensures dynamic require() calls work with relative paths from the original file location
@@ -81,7 +81,7 @@ const exports = module.exports;
 
 `
       }
-      
+
       if (usesCommonJSGlobals) {
         // For __dirname and __filename, also use the original file path
         const originalFileUrl = `file://${filePath.replace(/\\/g, '/')}`
@@ -92,48 +92,48 @@ const __dirname = __dirname_fn(__filename);
 
 `
       }
-      
+
       jsContent = esmGlobals + jsContent
-      
+
       // If module.exports is used, we need to export it as default
       if (usesModuleExports) {
         jsContent += `\nexport default module.exports;\n`
       }
     }
-    
+
     return jsContent
   }
-  
+
   // Create a map to track transpiled files
   const transpiledFiles = new Map()
   const baseDir = path.dirname(mainFilePath)
-  
+
   // Recursive function to transpile a file and all its TypeScript dependencies
   const transpileFileAndDeps = (filePath) => {
     // Already transpiled, skip
     if (transpiledFiles.has(filePath)) {
       return
     }
-    
+
     // Transpile this file
     let jsContent = transpileTS(filePath)
-    
+
     // Find all relative TypeScript imports in this file
     const importRegex = /from\s+['"](\..+?)(?:\.ts)?['"]/g
     let match
     const imports = []
-    
+
     while ((match = importRegex.exec(jsContent)) !== null) {
       imports.push(match[1])
     }
-    
+
     // Get the base directory for this file
     const fileBaseDir = path.dirname(filePath)
-    
+
     // Recursively transpile each imported TypeScript file
     for (const relativeImport of imports) {
       let importedPath = path.resolve(fileBaseDir, relativeImport)
-      
+
       // Handle .js extensions that might actually be .ts files
       if (importedPath.endsWith('.js')) {
         const tsVersion = importedPath.replace(/\.js$/, '.ts')
@@ -141,9 +141,14 @@ const __dirname = __dirname_fn(__filename);
           importedPath = tsVersion
         }
       }
-      
-      // Try adding .ts extension if file doesn't exist and no extension provided
-      if (!path.extname(importedPath)) {
+
+      // Check for standard module extensions to determine if we should try adding .ts
+      const ext = path.extname(importedPath)
+      const standardExtensions = ['.js', '.mjs', '.cjs', '.json', '.node']
+      const hasStandardExtension = standardExtensions.includes(ext.toLowerCase())
+
+      // If it doesn't end with .ts and doesn't have a standard extension, try adding .ts
+      if (!importedPath.endsWith('.ts') && !hasStandardExtension) {
         const tsPath = importedPath + '.ts'
         if (fs.existsSync(tsPath)) {
           importedPath = tsPath
@@ -156,19 +161,20 @@ const __dirname = __dirname_fn(__filename);
           }
         }
       }
-      
+
       // If it's a TypeScript file, recursively transpile it and its dependencies
       if (importedPath.endsWith('.ts') && fs.existsSync(importedPath)) {
         transpileFileAndDeps(importedPath)
       }
     }
-    
+
     // After all dependencies are transpiled, rewrite imports in this file
     jsContent = jsContent.replace(
       /from\s+['"](\..+?)(?:\.ts)?['"]/g,
       (match, importPath) => {
         let resolvedPath = path.resolve(fileBaseDir, importPath)
-        
+        const originalExt = path.extname(importPath)
+
         // Handle .js extension that might be .ts
         if (resolvedPath.endsWith('.js')) {
           const tsVersion = resolvedPath.replace(/\.js$/, '.ts')
@@ -181,11 +187,13 @@ const __dirname = __dirname_fn(__filename);
             }
             return `from '${relPath}'`
           }
+          // Keep .js extension as-is (might be a real .js file)
+          return match
         }
-        
+
         // Try with .ts extension
         const tsPath = resolvedPath.endsWith('.ts') ? resolvedPath : resolvedPath + '.ts'
-        
+
         // If we transpiled this file, use the temp file
         if (transpiledFiles.has(tsPath)) {
           const tempFile = transpiledFiles.get(tsPath)
@@ -196,28 +204,67 @@ const __dirname = __dirname_fn(__filename);
           }
           return `from '${relPath}'`
         }
-        
+
+        // If the import doesn't have a standard module extension (.js, .mjs, .cjs, .json)
+        // add .js for ESM compatibility
+        // This handles cases where:
+        // 1. Import has no real extension (e.g., "./utils" or "./helper")
+        // 2. Import has a non-standard extension that's part of the name (e.g., "./abstract.helper")
+        const standardExtensions = ['.js', '.mjs', '.cjs', '.json', '.node']
+        const hasStandardExtension = standardExtensions.includes(originalExt.toLowerCase())
+
+        if (!hasStandardExtension) {
+          return match.replace(importPath, importPath + '.js')
+        }
+
         // Otherwise, keep the import as-is
         return match
       }
     )
-    
+
     // Write the transpiled file with updated imports
     const tempFile = filePath.replace(/\.ts$/, '.temp.mjs')
     fs.writeFileSync(tempFile, jsContent)
     transpiledFiles.set(filePath, tempFile)
   }
-  
+
   // Start recursive transpilation from the main file
   transpileFileAndDeps(mainFilePath)
-  
+
   // Get the main transpiled file
   const tempJsFile = transpiledFiles.get(mainFilePath)
-  
+
   // Store all temp files for cleanup
   const allTempFiles = Array.from(transpiledFiles.values())
-  
-  return { tempFile: tempJsFile, allTempFiles }
+
+  return { tempFile: tempJsFile, allTempFiles, fileMapping: transpiledFiles }
+}
+
+/**
+ * Map error stack traces from temp .mjs files back to original .ts files
+ * @param {Error} error - The error object to fix
+ * @param {Map<string, string>} fileMapping - Map of original .ts files to temp .mjs files
+ * @returns {Error} - Error with fixed stack trace
+ */
+export function fixErrorStack(error, fileMapping) {
+  if (!error.stack || !fileMapping) return error
+
+  let stack = error.stack
+
+  // Create reverse mapping (temp.mjs -> original.ts)
+  const reverseMap = new Map()
+  for (const [tsFile, mjsFile] of fileMapping.entries()) {
+    reverseMap.set(mjsFile, tsFile)
+  }
+
+  // Replace all temp.mjs references with original .ts files
+  for (const [mjsFile, tsFile] of reverseMap.entries()) {
+    const mjsPattern = mjsFile.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')
+    stack = stack.replace(new RegExp(mjsPattern, 'g'), tsFile)
+  }
+
+  error.stack = stack
+  return error
 }
 
 /**

package/lib/workers.js

@@ -5,6 +5,7 @@ import { mkdirp } from 'mkdirp'
 import { Worker } from 'worker_threads'
 import { EventEmitter } from 'events'
 import ms from 'ms'
+import merge from 'lodash.merge'
 
 const __filename = fileURLToPath(import.meta.url)
 const __dirname = dirname(__filename)
@@ -66,21 +67,21 @@ const createWorker = (workerObject, isPoolMode = false) => {
     stdout: true,
     stderr: true,
   })
-  
+
   // Pipe worker stdout/stderr to main process
   if (worker.stdout) {
     worker.stdout.setEncoding('utf8')
-    worker.stdout.on('data', (data) => {
+    worker.stdout.on('data', data => {
       process.stdout.write(data)
     })
   }
   if (worker.stderr) {
     worker.stderr.setEncoding('utf8')
-    worker.stderr.on('data', (data) => {
+    worker.stderr.on('data', data => {
       process.stderr.write(data)
     })
   }
-  
+
   worker.on('error', err => {
     console.error(`[Main] Worker Error:`, err)
     output.error(`Worker Error: ${err.stack}`)
@@ -221,13 +222,13 @@ class WorkerObject {
 
   addConfig(config) {
     const oldConfig = JSON.parse(this.options.override || '{}')
-    
+
     // Remove customLocatorStrategies from both old and new config before JSON serialization
     // since functions cannot be serialized and will be lost, causing workers to have empty strategies
     const configWithoutFunctions = { ...config }
-    
+
     // Clean both old and new config
-    const cleanConfig = (cfg) => {
+    const cleanConfig = cfg => {
       if (cfg.helpers) {
         cfg.helpers = { ...cfg.helpers }
         Object.keys(cfg.helpers).forEach(helperName => {
@@ -239,14 +240,12 @@ class WorkerObject {
       }
       return cfg
     }
-    
+
     const cleanedOldConfig = cleanConfig(oldConfig)
     const cleanedNewConfig = cleanConfig(configWithoutFunctions)
-    
-    const newConfig = {
-      ...cleanedOldConfig,
-      ...cleanedNewConfig,
-    }
+
+    // Deep merge configurations to preserve all helpers from base config
+    const newConfig = merge({}, cleanedOldConfig, cleanedNewConfig)
     this.options.override = JSON.stringify(newConfig)
   }
 
@@ -280,8 +279,8 @@ class Workers extends EventEmitter {
     this.setMaxListeners(50)
     this.codeceptPromise = initializeCodecept(config.testConfig, config.options)
     this.codecept = null
-    this.config = config  // Save config
-    this.numberOfWorkersRequested = numberOfWorkers  // Save requested worker count
+    this.config = config // Save config
+    this.numberOfWorkersRequested = numberOfWorkers // Save requested worker count
     this.options = config.options || {}
     this.errors = []
     this.numberOfWorkers = 0
@@ -304,11 +303,8 @@ class Workers extends EventEmitter {
       // Initialize workers in these cases:
       // 1. Positive number requested AND no manual workers pre-spawned
       // 2. Function-based grouping (indicated by negative number) AND no manual workers pre-spawned
-      const shouldAutoInit = this.workers.length === 0 && (
-        (Number.isInteger(this.numberOfWorkersRequested) && this.numberOfWorkersRequested > 0) ||
-        (this.numberOfWorkersRequested < 0 && isFunction(this.config.by))
-      )
-      
+      const shouldAutoInit = this.workers.length === 0 && ((Number.isInteger(this.numberOfWorkersRequested) && this.numberOfWorkersRequested > 0) || (this.numberOfWorkersRequested < 0 && isFunction(this.config.by)))
+
       if (shouldAutoInit) {
         this._initWorkers(this.numberOfWorkersRequested, this.config)
       }
@@ -319,7 +315,7 @@ class Workers extends EventEmitter {
     this.splitTestsByGroups(numberOfWorkers, config)
     // For function-based grouping, use the actual number of test groups created
     const actualNumberOfWorkers = isFunction(config.by) ? this.testGroups.length : numberOfWorkers
-    this.workers = createWorkerObjects(this.testGroups, this.codecept.config, config.testConfig, config.options, config.selectedRuns)
+    this.workers = createWorkerObjects(this.testGroups, this.codecept.config, getTestRoot(config.testConfig), config.options, config.selectedRuns)
     this.numberOfWorkers = this.workers.length
   }
 
@@ -371,9 +367,9 @@ class Workers extends EventEmitter {
    * @param {Number} numberOfWorkers
    */
   createGroupsOfTests(numberOfWorkers) {
-  // If Codecept isn't initialized yet, return empty groups as a safe fallback
-  if (!this.codecept) return populateGroups(numberOfWorkers)
-  const files = this.codecept.testFiles
+    // If Codecept isn't initialized yet, return empty groups as a safe fallback
+    if (!this.codecept) return populateGroups(numberOfWorkers)
+    const files = this.codecept.testFiles
     const mocha = Container.mocha()
     mocha.files = files
     mocha.loadFiles()
@@ -430,7 +426,7 @@ class Workers extends EventEmitter {
     for (const file of files) {
       this.testPool.push(file)
     }
-    
+
     this.testPoolInitialized = true
   }
 
@@ -443,7 +439,7 @@ class Workers extends EventEmitter {
     if (!this.testPoolInitialized) {
       this._initializeTestPool()
     }
-    
+
     return this.testPool.shift()
   }
 
@@ -451,9 +447,9 @@ class Workers extends EventEmitter {
    * @param {Number} numberOfWorkers
    */
   createGroupsOfSuites(numberOfWorkers) {
-  // If Codecept isn't initialized yet, return empty groups as a safe fallback
-  if (!this.codecept) return populateGroups(numberOfWorkers)
-  const files = this.codecept.testFiles
+    // If Codecept isn't initialized yet, return empty groups as a safe fallback
+    if (!this.codecept) return populateGroups(numberOfWorkers)
+    const files = this.codecept.testFiles
     const groups = populateGroups(numberOfWorkers)
 
     const mocha = Container.mocha()
@@ -494,7 +490,7 @@ class Workers extends EventEmitter {
     recorder.startUnlessRunning()
     event.dispatcher.emit(event.workers.before)
     process.env.RUNS_WITH_WORKERS = 'true'
-    
+
     // Create workers and set up message handlers immediately (not in recorder queue)
     // This prevents a race condition where workers start sending messages before handlers are attached
     const workerThreads = []
@@ -503,11 +499,11 @@ class Workers extends EventEmitter {
       this._listenWorkerEvents(workerThread)
       workerThreads.push(workerThread)
     }
-    
+
     recorder.add('workers started', () => {
       // Workers are already running, this is just a placeholder step
     })
-    
+
     return new Promise(resolve => {
       this.on('end', resolve)
     })
@@ -591,7 +587,7 @@ class Workers extends EventEmitter {
           // Otherwise skip - we'll emit based on finished state
           break
         case event.test.passed:
-          // Skip individual passed events - we'll emit based on finished state  
+          // Skip individual passed events - we'll emit based on finished state
           break
         case event.test.skipped:
           this.emit(event.test.skipped, deserializeTest(message.data))
@@ -602,15 +598,15 @@ class Workers extends EventEmitter {
             const data = message.data
             const uid = data?.uid
             const isFailed = !!data?.err || data?.state === 'failed'
-            
+
             if (uid) {
               // Track states for each test UID
               if (!this._testStates) this._testStates = new Map()
-              
+
               if (!this._testStates.has(uid)) {
                 this._testStates.set(uid, { states: [], lastData: data })
               }
-              
+
               const testState = this._testStates.get(uid)
               testState.states.push({ isFailed, data })
               testState.lastData = data
@@ -622,7 +618,7 @@ class Workers extends EventEmitter {
                 this.emit(event.test.passed, deserializeTest(data))
               }
             }
-            
+
             this.emit(event.test.finished, deserializeTest(data))
           }
           break
@@ -682,11 +678,10 @@ class Workers extends EventEmitter {
         // For tests with retries configured, emit all failures + final success
         // For tests without retries, emit only final state
         const lastState = states[states.length - 1]
-        
+
         // Check if this test had retries by looking for failure followed by success
-        const hasRetryPattern = states.length > 1 && 
-          states.some((s, i) => s.isFailed && i < states.length - 1 && !states[i + 1].isFailed)
-        
+        const hasRetryPattern = states.length > 1 && states.some((s, i) => s.isFailed && i < states.length - 1 && !states[i + 1].isFailed)
+
         if (hasRetryPattern) {
           // Emit all intermediate failures and final success for retries
           for (const state of states) {