codeceptjs 4.0.0-beta.9.esm-aria → 4.0.0-rc.10

package/lib/container.js

@@ -1,9 +1,11 @@
 import { globSync } from 'glob'
 import path from 'path'
+import fs from 'fs'
 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, fixErrorStack } from './utils/typescript.js'
 import Translation from './translation.js'
 import MochaFactory from './mocha/factory.js'
 import recorder from './recorder.js'
@@ -20,6 +22,7 @@ let container = {
   helpers: {},
   support: {},
   proxySupport: {},
+  proxySupportConfig: {}, // Track config used to create proxySupport
   plugins: {},
   actor: null,
   /**
@@ -30,7 +33,8 @@ let container = {
   translation: {},
   /** @type {Result | null} */
   result: null,
-  sharedKeys: new Set() // Track keys shared via share() function
+  sharedKeys: new Set(), // Track keys shared via share() function
+  tsFileMapping: null, // TypeScript file mapping for error stack fixing
 }
 
 /**
@@ -65,14 +69,15 @@ class Container {
     container.support = {}
     container.helpers = await createHelpers(config.helpers || {})
     container.translation = await loadTranslation(config.translation || null, config.vocabularies || [])
-    container.proxySupport = createSupportObjects(config.include || {})
+    container.proxySupportConfig = config.include || {}
+    container.proxySupport = createSupportObjects(container.proxySupportConfig)
     container.plugins = await createPlugins(config.plugins || {}, opts)
     container.result = new Result()
 
     // Preload includes (so proxies can expose real objects synchronously)
     const includes = config.include || {}
 
-    // Ensure I is available for DI modules at import time
+    // Check if custom I is provided
     if (Object.prototype.hasOwnProperty.call(includes, 'I')) {
       try {
         const mod = includes.I
@@ -84,10 +89,10 @@ class Container {
           container.support.I = mod
         }
       } catch (e) {
-        throw new Error(`Could not include object I: ${e.message}`)
+        throw e
       }
     } else {
-      // Create default actor if not provided via includes
+      // Create default actor - this sets up the callback in asyncHelperPromise
       createActor()
     }
 
@@ -108,6 +113,9 @@ class Container {
       }
     }
 
+    // Wait for all async helpers to finish loading and populate the actor
+    await asyncHelperPromise
+
     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
@@ -169,6 +177,15 @@ class Container {
     return container.translation
   }
 
+  /**
+   * Get TypeScript file mapping for error stack fixing
+   *
+   * @api
+   */
+  static tsFileMapping() {
+    return container.tsFileMapping
+  }
+
   /**
    * Get Mocha instance
    *
@@ -202,8 +219,10 @@ class Container {
 
     // If new support objects are added, update the proxy support
     if (newContainer.support) {
-      const newProxySupport = createSupportObjects(newContainer.support)
-      container.proxySupport = { ...container.proxySupport, ...newProxySupport }
+      // Merge the new support config with existing config
+      container.proxySupportConfig = { ...container.proxySupportConfig, ...newContainer.support }
+      // Recreate the proxy with merged config
+      container.proxySupport = createSupportObjects(container.proxySupportConfig)
     }
 
     debug('appended', JSON.stringify(newContainer).slice(0, 300))
@@ -219,6 +238,7 @@ class Container {
   static async clear(newHelpers = {}, newSupport = {}, newPlugins = {}) {
     container.helpers = newHelpers
     container.translation = await loadTranslation()
+    container.proxySupportConfig = newSupport
     container.proxySupport = createSupportObjects(newSupport)
     container.plugins = newPlugins
     container.sharedKeys = new Set() // Clear shared keys
@@ -248,10 +268,10 @@ class Container {
     // Instead of using append which replaces the entire container,
     // directly update the support object to maintain proxy references
     Object.assign(container.support, data)
-    
+
     // Track which keys were explicitly shared
     Object.keys(data).forEach(key => container.sharedKeys.add(key))
-    
+
     if (!options.local) {
       WorkerStorage.share(data)
     }
@@ -290,7 +310,7 @@ async function createHelpers(config) {
       if (!HelperClass) {
         const helperResult = requireHelperFromModule(helperName, config)
         if (helperResult instanceof Promise) {
-          // Handle async ESM loading
+          // Handle async ESM loading - create placeholder
           helpers[helperName] = {}
           asyncHelperPromise = asyncHelperPromise
             .then(() => helperResult)
@@ -309,8 +329,7 @@ async function createHelpers(config) {
 
               checkHelperRequirements(ResolvedHelperClass)
               helpers[helperName] = new ResolvedHelperClass(config[helperName])
-              if (helpers[helperName]._init) await helpers[helperName]._init()
-              debug(`helper ${helperName} async initialized`)
+              debug(`helper ${helperName} async loaded`)
             })
           continue
         } else {
@@ -330,9 +349,8 @@ async function createHelpers(config) {
               throw new Error(`Helper class from module '${helperName}' is not a class. Use CJS async module syntax.`)
             }
 
-            debug(`helper ${helperName} async initialized`)
-
             helpers[helperName] = new ResolvedHelperClass(config[helperName])
+            debug(`helper ${helperName} async CJS loaded`)
           })
 
         continue
@@ -347,9 +365,18 @@ async function createHelpers(config) {
     }
   }
 
-  for (const name in helpers) {
-    if (helpers[name]._init) await helpers[name]._init()
-  }
+  // Don't await here - let Container.create() handle the await
+  // This allows actor callbacks to be registered before resolution
+  asyncHelperPromise = asyncHelperPromise.then(async () => {
+    // Call _init on all helpers after they're all loaded
+    for (const name in helpers) {
+      if (helpers[name]._init) {
+        await helpers[name]._init()
+        debug(`helper ${name} _init() called`)
+      }
+    }
+  })
+
   return helpers
 }
 
@@ -381,20 +408,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 (!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 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`)
@@ -523,10 +596,17 @@ function createSupportObjects(config) {
         return [...new Set([...keys, ...container.sharedKeys])]
       },
       getOwnPropertyDescriptor(target, prop) {
+        // For destructuring to work, we need to return the actual value from the getter
+        let value
+        if (container.sharedKeys.has(prop) && prop in container.support) {
+          value = container.support[prop]
+        } else {
+          value = lazyLoad(prop)
+        }
         return {
           enumerable: true,
           configurable: true,
-          value: target[prop],
+          value: value,
         }
       },
       get(target, key) {
@@ -577,13 +657,28 @@ async function createPlugins(config, options = {}) {
   const enabledPluginsByOptions = (options.plugins || '').split(',')
   for (const pluginName in config) {
     if (!config[pluginName]) config[pluginName] = {}
-    if (!config[pluginName].enabled && enabledPluginsByOptions.indexOf(pluginName) < 0) {
+    const pluginConfig = config[pluginName]
+    if (!pluginConfig.enabled && enabledPluginsByOptions.indexOf(pluginName) < 0) {
       continue // plugin is disabled
     }
+
+    // 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 && process.env.RUNS_WITH_WORKERS === 'true' && !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
@@ -593,7 +688,7 @@ async function createPlugins(config, options = {}) {
       }
 
       // 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}`)
@@ -674,12 +769,64 @@ async function loadSupportObject(modulePath, supportObjectName) {
   try {
     // Use dynamic import for both ESM and CJS modules
     let importPath = modulePath
-    // Append .js if no extension provided (ESM resolution requires it)
+    let tempJsFile = null
+    let fileMapping = null
+
     if (typeof importPath === 'string') {
       const ext = path.extname(importPath)
-      if (!ext) importPath = `${importPath}.js`
+
+      // Handle TypeScript files
+      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 file: ${importPath} -> ${tempFile}`)
+
+          // Attach cleanup handler
+          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.`)
+        }
+      } else if (!ext) {
+        // Append .js if no extension provided (ESM resolution requires it)
+        importPath = `${importPath}.js`
+      }
+    }
+
+    let obj
+    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]
+        cleanupTempFiles(filesToClean)
+      }
+      throw importError
+    } finally {
+      // Clean up temp files if created
+      if (tempJsFile) {
+        const filesToClean = Array.isArray(tempJsFile) ? tempJsFile : [tempJsFile]
+        cleanupTempFiles(filesToClean)
+      }
     }
-    const obj = await import(importPath)
 
     // Handle ESM module wrapper
     let actualObj = obj
@@ -715,7 +862,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
   }
 }
 

package/lib/element/WebElement.js

@@ -1,4 +1,5 @@
 import assert from 'assert'
+import { simplifyHtmlElement } from '../html.js'
 
 /**
  * Unified WebElement class that wraps native element instances from different helpers
@@ -81,6 +82,10 @@ class WebElement {
   async getProperty(name) {
     switch (this.helperType) {
       case 'playwright':
+        // For Locator objects, use inputValue() for the 'value' property
+        if (name === 'value' && this.element.inputValue) {
+          return this.element.inputValue()
+        }
         return this.element.evaluate((el, propName) => el[propName], name)
       case 'webdriver':
         return this.element.getProperty(name)
@@ -236,10 +241,15 @@ class WebElement {
   async type(text, options = {}) {
     switch (this.helperType) {
       case 'playwright':
+        // Playwright Locator objects use fill() instead of type()
+        if (this.element.fill) {
+          return this.element.fill(text, options)
+        }
         return this.element.type(text, options)
       case 'webdriver':
         return this.element.setValue(text)
       case 'puppeteer':
+        await this.element.evaluate(el => { el.value = '' })
         return this.element.type(text, options)
       default:
         throw new Error(`Unsupported helper type: ${this.helperType}`)
@@ -256,7 +266,18 @@ class WebElement {
 
     switch (this.helperType) {
       case 'playwright':
-        childElement = await this.element.$(this._normalizeLocator(locator))
+        // Playwright Locator objects use locator() method
+        if (this.element.locator) {
+          const childLocator = this.element.locator(this._normalizeLocator(locator))
+          // Get the element handle from the locator
+          try {
+            childElement = await childLocator.elementHandle()
+          } catch (e) {
+            return null
+          }
+        } else {
+          childElement = await this.element.$(this._normalizeLocator(locator))
+        }
         break
       case 'webdriver':
         try {
@@ -285,7 +306,14 @@ class WebElement {
 
     switch (this.helperType) {
       case 'playwright':
-        childElements = await this.element.$$(this._normalizeLocator(locator))
+        // Playwright Locator objects use locator() method
+        if (this.element.locator) {
+          const childLocator = this.element.locator(this._normalizeLocator(locator))
+          // Get all element handles from the locator
+          childElements = await childLocator.elementHandles()
+        } else {
+          childElements = await this.element.$$(this._normalizeLocator(locator))
+        }
         break
       case 'webdriver':
         childElements = await this.element.$$(this._normalizeLocator(locator))
@@ -306,6 +334,57 @@ class WebElement {
    * @returns {string} Normalized CSS selector
    * @private
    */
+  async toAbsoluteXPath() {
+    const xpathFn = (el) => {
+      const parts = []
+      let current = el
+      while (current && current.nodeType === Node.ELEMENT_NODE) {
+        let index = 0
+        let sibling = current.previousSibling
+        while (sibling) {
+          if (sibling.nodeType === Node.ELEMENT_NODE && sibling.tagName === current.tagName) {
+            index++
+          }
+          sibling = sibling.previousSibling
+        }
+        const tagName = current.tagName.toLowerCase()
+        const pathIndex = index > 0 ? `[${index + 1}]` : ''
+        parts.unshift(`${tagName}${pathIndex}`)
+        current = current.parentElement
+      }
+      return '//' + parts.join('/')
+    }
+
+    switch (this.helperType) {
+      case 'playwright':
+        return this.element.evaluate(xpathFn)
+      case 'puppeteer':
+        return this.element.evaluate(xpathFn)
+      case 'webdriver':
+        return this.helper.browser.execute(xpathFn, this.element)
+      default:
+        throw new Error(`Unsupported helper type: ${this.helperType}`)
+    }
+  }
+
+  async toOuterHTML() {
+    switch (this.helperType) {
+      case 'playwright':
+        return this.element.evaluate(el => el.outerHTML)
+      case 'puppeteer':
+        return this.element.evaluate(el => el.outerHTML)
+      case 'webdriver':
+        return this.helper.browser.execute(el => el.outerHTML, this.element)
+      default:
+        throw new Error(`Unsupported helper type: ${this.helperType}`)
+    }
+  }
+
+  async toSimplifiedHTML(maxLength = 300) {
+    const outerHTML = await this.toOuterHTML()
+    return simplifyHtmlElement(outerHTML, maxLength)
+  }
+
   _normalizeLocator(locator) {
     if (typeof locator === 'string') {
       return locator

package/lib/els.js

@@ -6,10 +6,11 @@ import recordStep from './step/record.js'
 import FuncStep from './step/func.js'
 import { truth } from './assert/truth.js'
 import { isAsyncFunction, humanizeFunction } from './utils.js'
+import WebElement from './element/WebElement.js'
 
 function element(purpose, locator, fn) {
   let stepConfig
-  if (arguments[arguments.length - 1] instanceof StepConfig) {
+  if (StepConfig.isStepConfig(arguments[arguments.length - 1])) {
     stepConfig = arguments[arguments.length - 1]
   }
 
@@ -28,7 +29,8 @@ function element(purpose, locator, fn) {
       const els = await step.helper._locate(locator)
       output.debug(`Found ${els.length} elements, using first element`)
 
-      return fn(els[0])
+      const wrapped = new WebElement(els[0], step.helper)
+      return fn(wrapped)
     },
     stepConfig,
   )
@@ -52,7 +54,8 @@ function eachElement(purpose, locator, fn) {
     let i = 0
     for (const el of els) {
       try {
-        await fn(el, i)
+        const wrapped = new WebElement(el, step.helper)
+        await fn(wrapped, i)
       } catch (err) {
         output.error(`eachElement: failed operation on element #${i} ${el}`)
         errs.push(err)
@@ -74,7 +77,8 @@ function expectElement(locator, fn) {
     const els = await step.helper._locate(locator)
     output.debug(`Found ${els.length} elements, first will be used for assertion`)
 
-    const result = await fn(els[0])
+    const wrapped = new WebElement(els[0], step.helper)
+    const result = await fn(wrapped)
     const assertion = truth(`element (${locator})`, fn.toString())
     assertion.assert(result)
   })
@@ -92,7 +96,8 @@ function expectAnyElement(locator, fn) {
 
     let found = false
     for (const el of els) {
-      const result = await fn(el)
+      const wrapped = new WebElement(el, step.helper)
+      const result = await fn(wrapped)
       if (result) {
         found = true
         break
@@ -113,7 +118,8 @@ function expectAllElements(locator, fn) {
     let i = 1
     for (const el of els) {
       output.debug(`checking element #${i}: ${el}`)
-      const result = await fn(el)
+      const wrapped = new WebElement(el, step.helper)
+      const result = await fn(wrapped)
       const assertion = truth(`element #${i} of (${locator})`, humanizeFunction(fn))
       assertion.assert(result)
       i++

package/lib/helper/Appium.js

@@ -1543,8 +1543,8 @@ class Appium extends Webdriver {
   /**
    * {{> dontSeeElement }}
    */
-  async dontSeeElement(locator) {
-    if (this.isWeb) return super.dontSeeElement(locator)
+  async dontSeeElement(locator, context = null) {
+    if (this.isWeb) return super.dontSeeElement(locator, context)
 
     // For mobile native apps, use safe isDisplayed wrapper
     const parsedLocator = parseLocator.call(this, locator)
@@ -1589,9 +1589,9 @@ class Appium extends Webdriver {
    * {{> fillField }}
    *
    */
-  async fillField(field, value) {
+  async fillField(field, value, context = null) {
     value = value.toString()
-    if (this.isWeb) return super.fillField(field, value)
+    if (this.isWeb) return super.fillField(field, value, context)
     return super.fillField(parseLocator.call(this, field), value)
   }
 
@@ -1706,8 +1706,8 @@ class Appium extends Webdriver {
    * {{> seeElement }}
    *
    */
-  async seeElement(locator) {
-    if (this.isWeb) return super.seeElement(locator)
+  async seeElement(locator, context = null) {
+    if (this.isWeb) return super.seeElement(locator, context)
 
     // For mobile native apps, use safe isDisplayed wrapper
     const parsedLocator = parseLocator.call(this, locator)
@@ -1754,8 +1754,8 @@ class Appium extends Webdriver {
    *
    * Supported only for web testing
    */
-  async selectOption(select, option) {
-    if (this.isWeb) return super.selectOption(select, option)
+  async selectOption(select, option, context = null) {
+    if (this.isWeb) return super.selectOption(select, option, context)
     throw new Error("Should be used only in Web context. In native context use 'click' method instead")
   }
 

package/lib/helper/GraphQL.js

@@ -45,6 +45,8 @@ class GraphQL extends Helper {
       timeout: 10000,
       defaultHeaders: {},
       endpoint: '',
+      onRequest: null,
+      onResponse: null,
     }
     this.options = Object.assign(this.options, config)
     this.headers = { ...this.options.defaultHeaders }
@@ -87,8 +89,8 @@ class GraphQL extends Helper {
 
     request.headers = { ...this.headers, ...request.headers }
 
-    if (this.config.onRequest) {
-      await this.config.onRequest(request)
+    if (this.options.onRequest) {
+      await this.options.onRequest(request)
     }
 
     this.debugSection('Request', JSON.stringify(request))
@@ -102,8 +104,8 @@ class GraphQL extends Helper {
       response = err.response
     }
 
-    if (this.config.onResponse) {
-      await this.config.onResponse(response)
+    if (this.options.onResponse) {
+      await this.options.onResponse(response)
     }
 
     this.debugSection('Response', JSON.stringify(response.data))

package/lib/helper/JSONResponse.js

@@ -72,8 +72,8 @@ class JSONResponse extends Helper {
     if (!this.helpers[this.options.requestHelper]) {
       throw new Error(`Error setting JSONResponse, helper ${this.options.requestHelper} is not enabled in config, helpers: ${Object.keys(this.helpers)}`)
     }
-    const origOnResponse = this.helpers[this.options.requestHelper].config.onResponse
-    this.helpers[this.options.requestHelper].config.onResponse = response => {
+    const origOnResponse = this.helpers[this.options.requestHelper].options.onResponse
+    this.helpers[this.options.requestHelper].options.onResponse = response => {
       this.response = response
       if (typeof origOnResponse === 'function') origOnResponse(response)
     }
@@ -83,7 +83,6 @@ class JSONResponse extends Helper {
     this.response = null
   }
 
-  
   /**
    * Checks that response code is equal to the provided one
    *
@@ -372,4 +371,4 @@ class JSONResponse extends Helper {
   }
 }
 
-export { JSONResponse as default }
+export { JSONResponse, JSONResponse as default }