codeceptjs 4.0.1-beta.9 → 4.0.1

package/lib/container.js

@@ -5,7 +5,7 @@ import debugModule from 'debug'
 const debug = debugModule('codeceptjs:container')
 import { MetaStep } from './step.js'
 import { methodsOfObject, fileExists, isFunction, isAsyncFunction, installedLocally, deepMerge } from './utils.js'
-import { transpileTypeScript, cleanupTempFiles } from './utils/typescript.js'
+import { transpileTypeScript, cleanupTempFiles, fixErrorStack } from './utils/typescript.js'
 import Translation from './translation.js'
 import MochaFactory from './mocha/factory.js'
 import recorder from './recorder.js'
@@ -15,9 +15,15 @@ import store from './store.js'
 import Result from './result.js'
 import ai from './ai.js'
 import actorFactory from './actor.js'
+import Config from './config.js'
 
 let asyncHelperPromise
 
+let beforeCalledSet = new Set()
+
+export function getBeforeCalledSet() { return beforeCalledSet }
+export function resetBeforeCalledSet() { beforeCalledSet = new Set() }
+
 let container = {
   helpers: {},
   support: {},
@@ -34,6 +40,7 @@ let container = {
   /** @type {Result | null} */
   result: null,
   sharedKeys: new Set(), // Track keys shared via share() function
+  tsFileMapping: null, // TypeScript file mapping for error stack fixing
 }
 
 /**
@@ -88,7 +95,7 @@ class Container {
           container.support.I = mod
         }
       } catch (e) {
-        throw new Error(`Could not include object I: ${e.message}`)
+        throw e
       }
     } else {
       // Create default actor - this sets up the callback in asyncHelperPromise
@@ -115,6 +122,18 @@ class Container {
     // Wait for all async helpers to finish loading and populate the actor
     await asyncHelperPromise
 
+    // Plugins may have registered Config hooks during their boot. Run anything
+    // that hasn't been applied yet and re-feed the mutated helper config to the
+    // already-instantiated helpers.
+    if (Config.runPendingHooks(config)) {
+      for (const name of Object.keys(container.helpers)) {
+        const helper = container.helpers[name]
+        if (helper && typeof helper._setConfig === 'function' && config.helpers && config.helpers[name]) {
+          helper._setConfig(config.helpers[name])
+        }
+      }
+    }
+
     if (opts && opts.ai) ai.enable(config.ai) // enable AI Assistant
     if (config.gherkin) await loadGherkinStepsAsync(config.gherkin.steps || [])
     if (opts && typeof opts.timeouts === 'boolean') store.timeouts = opts.timeouts
@@ -149,10 +168,23 @@ class Container {
     if (!name) {
       return container.proxySupport
     }
-    // Always return the proxy to ensure MetaStep creation works
+    if (typeof container.support[name] === 'function') {
+      return container.support[name]
+    }
     return container.proxySupport[name]
   }
 
+  /**
+   * Get raw (non-proxied) support objects for direct access.
+   * Used by listeners to call lifecycle hooks without MetaStep wrapping.
+   *
+   * @api
+   * @returns {object}
+   */
+  static supportObjects() {
+    return container.support
+  }
+
   /**
    * Get all helpers or get a helper by name
    *
@@ -176,6 +208,15 @@ class Container {
     return container.translation
   }
 
+  /**
+   * Get TypeScript file mapping for error stack fixing
+   *
+   * @api
+   */
+  static tsFileMapping() {
+    return store.tsFileMapping
+  }
+
   /**
    * Get Mocha instance
    *
@@ -398,20 +439,66 @@ async function requireHelperFromModule(helperName, config, HelperClass) {
       throw err
     }
   } else {
+    // Handle TypeScript files
+    let importPath = moduleName
+    let tempJsFile = null
+    let fileMapping = null
+    const ext = path.extname(moduleName)
+
+    if (ext === '.ts') {
+      try {
+        // Use the TypeScript transpilation utility
+        const typescript = await import('typescript')
+        const { tempFile, allTempFiles, fileMapping: mapping } = await transpileTypeScript(importPath, typescript)
+
+        debug(`Transpiled TypeScript helper: ${importPath} -> ${tempFile}`)
+
+        importPath = tempFile
+        tempJsFile = allTempFiles
+        fileMapping = mapping
+        // Store file mapping in container for runtime error fixing (merge with existing)
+        if (!store.tsFileMapping) {
+          store.tsFileMapping = new Map()
+        }
+        for (const [key, value] of mapping.entries()) {
+          store.tsFileMapping.set(key, value)
+        }
+      } catch (tsError) {
+        throw new Error(`Failed to load TypeScript helper ${importPath}: ${tsError.message}. Make sure 'typescript' package is installed.`)
+      }
+    }
+
     // check if the new syntax export default HelperName is used and loads the Helper, otherwise loads the module that used old syntax export = HelperName.
     try {
       // Try dynamic import for both CommonJS and ESM modules
-      const mod = await import(moduleName)
+      const mod = await import(importPath)
       if (!mod && !mod.default) {
         throw new Error(`Helper module '${moduleName}' was not found. Make sure you have installed the package correctly.`)
       }
       HelperClass = mod.default || mod
+
+      // Clean up temp files if created
+      if (tempJsFile) {
+        const filesToClean = Array.isArray(tempJsFile) ? tempJsFile : [tempJsFile]
+        cleanupTempFiles(filesToClean)
+      }
     } catch (err) {
+      // Fix error stack to point to original .ts files
+      if (fileMapping) {
+        fixErrorStack(err, fileMapping)
+      }
+      
+      // Clean up temp files before rethrowing
+      if (tempJsFile) {
+        const filesToClean = Array.isArray(tempJsFile) ? tempJsFile : [tempJsFile]
+        cleanupTempFiles(filesToClean)
+      }
+
       if (err.code === 'ERR_REQUIRE_ESM' || (err.message && err.message.includes('ES module'))) {
         // This is an ESM module, use dynamic import
         try {
           const pathModule = await import('path')
-          const absolutePath = pathModule.default.resolve(moduleName)
+          const absolutePath = pathModule.default.resolve(importPath)
           const mod = await import(absolutePath)
           HelperClass = mod.default || mod
           debug(`helper ${helperName} loaded via ESM import`)
@@ -486,6 +573,19 @@ function createSupportObjects(config) {
           let currentValue = currentObject[prop]
 
           if (isFunction(currentValue) || isAsyncFunction(currentValue)) {
+            if (prop.toString().charAt(0) !== '_' && currentObject._before && !beforeCalledSet.has(name)) {
+              beforeCalledSet.add(name)
+              const originalValue = currentValue
+              const wrappedValue = async function (...args) {
+                await currentObject._before()
+                return originalValue.apply(currentObject, args)
+              }
+              const ms = new MetaStep(name, prop)
+              ms.setContext(currentObject)
+              debug(`metastep is created for ${name}.${prop.toString()}() (with _before)`)
+              return ms.run.bind(ms, asyncWrapper(wrappedValue))
+            }
+
             const ms = new MetaStep(name, prop)
             ms.setContext(currentObject)
             if (isAsyncFunction(currentValue)) currentValue = asyncWrapper(currentValue)
@@ -544,6 +644,8 @@ function createSupportObjects(config) {
         let value
         if (container.sharedKeys.has(prop) && prop in container.support) {
           value = container.support[prop]
+        } else if (prop in container.support && typeof container.support[prop] === 'function') {
+          value = container.support[prop]
         } else {
           value = lazyLoad(prop)
         }
@@ -558,6 +660,9 @@ function createSupportObjects(config) {
         if (container.sharedKeys.has(key) && key in container.support) {
           return container.support[key]
         }
+        if (key in container.support && typeof container.support[key] === 'function') {
+          return container.support[key]
+        }
         return lazyLoad(key)
       },
     },
@@ -598,26 +703,55 @@ async function loadPluginFallback(modulePath, config) {
 async function createPlugins(config, options = {}) {
   const plugins = {}
 
-  const enabledPluginsByOptions = (options.plugins || '').split(',')
+  const pluginOptionMap = new Map()
+  for (const token of (options.plugins || '').split(',').filter(Boolean)) {
+    const parts = token.split(':')
+    pluginOptionMap.set(parts[0], parts.slice(1))
+  }
+
+  for (const [name] of pluginOptionMap) {
+    if (!config[name]) config[name] = {}
+  }
+
   for (const pluginName in config) {
     if (!config[pluginName]) config[pluginName] = {}
-    if (!config[pluginName].enabled && enabledPluginsByOptions.indexOf(pluginName) < 0) {
+    const pluginConfig = config[pluginName]
+    const enabledByCli = pluginOptionMap.has(pluginName)
+    if (!pluginConfig.enabled && !enabledByCli) {
       continue // plugin is disabled
     }
+
+    if (enabledByCli && pluginOptionMap.get(pluginName).length > 0) {
+      pluginConfig._args = pluginOptionMap.get(pluginName)
+    }
+
+    // Generic workers gate:
+    // - runInWorker / runInWorkers controls plugin execution inside worker threads.
+    // - runInParent / runInMain can disable plugin in workers parent process.
+    const runInWorker = pluginConfig.runInWorker ?? pluginConfig.runInWorkers ?? (pluginName === 'testomatio' ? false : true)
+    const runInParent = pluginConfig.runInParent ?? pluginConfig.runInMain ?? true
+
+    if (options.child && !runInWorker) {
+      continue
+    }
+
+    if (!options.child && store.workerMode && !runInParent) {
+      continue
+    }
     let module
     try {
-      if (config[pluginName].require) {
-        module = config[pluginName].require
+      if (pluginConfig.require) {
+        module = pluginConfig.require
         if (module.startsWith('.')) {
           // local
-          module = path.resolve(global.codecept_dir, module) // custom plugin
+          module = path.resolve(store.codeceptDir, module) // custom plugin
         }
       } else {
         module = `./plugin/${pluginName}.js`
       }
 
       // Use async loading for all plugins (ESM and CJS)
-      plugins[pluginName] = await loadPluginAsync(module, config[pluginName])
+      plugins[pluginName] = await loadPluginAsync(module, pluginConfig)
       debug(`plugin ${pluginName} loaded via async import`)
     } catch (err) {
       throw new Error(`Could not load plugin ${pluginName} from module '${module}':\n${err.message}\n${err.stack}`)
@@ -627,12 +761,24 @@ async function createPlugins(config, options = {}) {
 }
 
 async function loadGherkinStepsAsync(paths) {
+  // Import BDD module to access step file tracking functions and step DSL
+  const bddModule = await import('./mocha/bdd.js')
+
   global.Before = fn => event.dispatcher.on(event.test.started, fn)
   global.After = fn => event.dispatcher.on(event.test.finished, fn)
   global.Fail = fn => event.dispatcher.on(event.test.failed, fn)
 
-  // Import BDD module to access step file tracking functions
-  const bddModule = await import('./mocha/bdd.js')
+  // Scope-inject Given/When/Then/And while loading step files so they work
+  // with noGlobals: true. When noGlobals: false, globals.js has already set
+  // them as permanent globals — skip to avoid deleting them at the end.
+  const injectStepDsl = !!store.noGlobals
+  if (injectStepDsl) {
+    global.Given = bddModule.Given
+    global.When = bddModule.When
+    global.Then = bddModule.Then
+    global.And = bddModule.And
+    global.DefineParameterType = bddModule.defineParameterType
+  }
 
   // If gherkin.steps is string, then this will iterate through that folder and send all step def js files to loadSupportObject
   // If gherkin.steps is Array, it will go the old way
@@ -645,7 +791,7 @@ async function loadGherkinStepsAsync(paths) {
       bddModule.clearCurrentStepFile()
     }
   } else {
-    const folderPath = paths.startsWith('.') ? normalizeAndJoin(global.codecept_dir, paths) : ''
+    const folderPath = paths.startsWith('.') ? normalizeAndJoin(store.codeceptDir, paths) : ''
     if (folderPath !== '') {
       const files = globSync(folderPath)
       for (const file of files) {
@@ -660,6 +806,13 @@ async function loadGherkinStepsAsync(paths) {
   delete global.Before
   delete global.After
   delete global.Fail
+  if (injectStepDsl) {
+    delete global.Given
+    delete global.When
+    delete global.Then
+    delete global.And
+    delete global.DefineParameterType
+  }
 }
 
 function loadGherkinSteps(paths) {
@@ -693,12 +846,13 @@ async function loadSupportObject(modulePath, supportObjectName) {
     }
   }
   if (typeof modulePath === 'string' && modulePath.charAt(0) === '.') {
-    modulePath = path.join(global.codecept_dir, modulePath)
+    modulePath = path.join(store.codeceptDir, modulePath)
   }
   try {
     // Use dynamic import for both ESM and CJS modules
     let importPath = modulePath
     let tempJsFile = null
+    let fileMapping = null
 
     if (typeof importPath === 'string') {
       const ext = path.extname(importPath)
@@ -708,7 +862,7 @@ async function loadSupportObject(modulePath, supportObjectName) {
         try {
           // Use the TypeScript transpilation utility
           const typescript = await import('typescript')
-          const { tempFile, allTempFiles } = await transpileTypeScript(importPath, typescript)
+          const { tempFile, allTempFiles, fileMapping: mapping } = await transpileTypeScript(importPath, typescript)
 
           debug(`Transpiled TypeScript file: ${importPath} -> ${tempFile}`)
 
@@ -716,6 +870,14 @@ async function loadSupportObject(modulePath, supportObjectName) {
           importPath = tempFile
           // Store temp files list in a way that cleanup can access them
           tempJsFile = allTempFiles
+          fileMapping = mapping
+          // Store file mapping in container for runtime error fixing (merge with existing)
+          if (!container.tsFileMapping) {
+            container.tsFileMapping = new Map()
+          }
+          for (const [key, value] of mapping.entries()) {
+            container.tsFileMapping.set(key, value)
+          }
         } catch (tsError) {
           throw new Error(`Failed to load TypeScript file ${importPath}: ${tsError.message}. Make sure 'typescript' package is installed.`)
         }
@@ -729,6 +891,11 @@ async function loadSupportObject(modulePath, supportObjectName) {
     try {
       obj = await import(importPath)
     } catch (importError) {
+      // Fix error stack to point to original .ts files
+      if (fileMapping) {
+        fixErrorStack(importError, fileMapping)
+      }
+      
       // Clean up temp files if created before rethrowing
       if (tempJsFile) {
         const filesToClean = Array.isArray(tempJsFile) ? tempJsFile : [tempJsFile]
@@ -777,7 +944,9 @@ async function loadSupportObject(modulePath, supportObjectName) {
 
     throw new Error(`Support object "${supportObjectName}" should be an object, class, or function, but got ${typeof actualObj}`)
   } catch (err) {
-    throw new Error(`Could not include object ${supportObjectName} from module '${modulePath}'\n${err.message}\n${err.stack}`)
+    const newErr = new Error(`Could not include object ${supportObjectName} from module '${modulePath}': ${err.message}`)
+    newErr.stack = err.stack
+    throw newErr
   }
 }
 
@@ -801,7 +970,7 @@ async function loadTranslation(locale, vocabularies) {
   const langs = await Translation.getLangs()
   if (langs[locale]) {
     translation = new Translation(langs[locale])
-  } else if (fileExists(path.join(global.codecept_dir, locale))) {
+  } else if (fileExists(path.join(store.codeceptDir, locale))) {
     // get from a provided file instead
     translation = Translation.createDefault()
     translation.loadVocabulary(locale)
@@ -818,7 +987,7 @@ function getHelperModuleName(helperName, config) {
   // classical require
   if (config[helperName].require) {
     if (config[helperName].require.startsWith('.')) {
-      let helperPath = path.resolve(global.codecept_dir, config[helperName].require)
+      let helperPath = path.resolve(store.codeceptDir, config[helperName].require)
       // Add .js extension if not present for ESM compatibility
       if (!path.extname(helperPath)) {
         helperPath += '.js'

package/lib/effects.js

@@ -4,6 +4,7 @@ import store from './store.js'
 import event from './event.js'
 import container from './container.js'
 import MetaStep from './step/meta.js'
+import { empty } from './assert/empty.js'
 import { isAsyncFunction } from './utils.js'
 
 /**
@@ -111,6 +112,11 @@ class WithinStep extends MetaStep {
  *
  * @throws Will handle errors that occur during the callback execution. Errors are logged and attached as notes to the test.
  */
+let hopeThatFailures = []
+event.dispatcher.on(event.test.before, () => {
+  hopeThatFailures = []
+})
+
 async function hopeThat(callback) {
   if (store.dryRun) return
   const sessionName = 'hopeThat'
@@ -131,6 +137,7 @@ async function hopeThat(callback) {
         result = false
         const msg = err.inspect ? err.inspect() : err.toString()
         output.debug(`Unsuccessful assertion > ${msg}`)
+        hopeThatFailures.push(msg)
         event.dispatcher.once(event.test.finished, test => {
           if (!test.notes) test.notes = []
           test.notes.push({ type: 'conditionalError', text: msg })
@@ -153,6 +160,16 @@ async function hopeThat(callback) {
   )
 }
 
+/**
+ * Asserts that no `hopeThat` soft assertion has failed in the current test.
+ * Call once at the end of a scenario to fail it when any soft assertion failed.
+ */
+hopeThat.noErrors = function () {
+  const failures = hopeThatFailures
+  hopeThatFailures = []
+  empty('soft assertions').assert(failures)
+}
+
 /**
  * A CodeceptJS utility function to retry a step or callback multiple times with a specified polling interval.
  *