codeceptjs 4.0.0-rc.8 → 4.0.0

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/globals.js

@@ -8,27 +8,47 @@ import fsPath from 'path'
 import ActorFactory from './actor.js'
 import output from './output.js'
 import locator from './locator.js'
+import store from './store.js'
 
 /**
  * Initialize CodeceptJS core globals
  * Called from Codecept.initGlobals()
  */
 export async function initCodeceptGlobals(dir, config, container) {
+  store.initialize({
+    codeceptDir: dir,
+    outputDir: fsPath.resolve(dir, config.output),
+  })
+
+  store.noGlobals = config.noGlobals || false
+  store.maskSensitiveData = config.maskSensitiveData || false
+
+  // Keep globals for backward compat with external plugins
   global.codecept_dir = dir
   global.output_dir = fsPath.resolve(dir, config.output)
 
-  if (config.noGlobals) return;
-    // Set up actor global - will use container when available
-  global.actor = global.codecept_actor = (obj) => {
-    return ActorFactory(obj, global.container || container)
-  }
-  global.Actor = global.actor
-
-  // Use dynamic imports for modules to avoid circular dependencies
+  // pause/inject/share stay global even under noGlobals — they're the everyday
+  // debugging/wiring entry points and have no useful import alternative for
+  // page-object code that runs before the container is available.
   global.pause = async (...args) => {
     const pauseModule = await import('./pause.js')
     return (pauseModule.default || pauseModule)(...args)
   }
+  global.inject = () => container.support()
+  global.share = container.share
+
+  if (config.noGlobals) return;
+
+  output.print(output.styles.debug('Global functions are deprecated. Use `import { Helper, within, session } from "codeceptjs"` instead. Set `noGlobals: true` in config to disable globals.'));
+
+  const HelperModule = await import('@codeceptjs/helper')
+  global.Helper = global.codecept_helper = HelperModule.default || HelperModule
+
+  // Set up actor global - will use container when available
+  global.actor = global.codecept_actor = (obj) => {
+    return ActorFactory(obj, container)
+  }
+  global.Actor = global.actor
 
   global.within = async (...args) => {
     return (await import('./effects.js')).within(...args)
@@ -46,14 +66,9 @@ export async function initCodeceptGlobals(dir, config, container) {
     return locator.build(locatorQuery)
   }
 
-  global.inject = () => container.support()
-  global.share = container.share
-
   const secretModule = await import('./secret.js')
   global.secret = secretModule.secret || (secretModule.default && secretModule.default.secret)
 
-  global.codecept_debug = output.debug
-
   const codeceptjsModule = await import('./index.js') // load all objects
   global.codeceptjs = codeceptjsModule.default || codeceptjsModule
 
@@ -65,9 +80,6 @@ export async function initCodeceptGlobals(dir, config, container) {
   global.Then = stepDefinitions.Then
   global.DefineParameterType = stepDefinitions.defineParameterType
 
-  // debug mode
-  global.debugMode = false
-
   // mask sensitive data
   global.maskSensitiveData = config.maskSensitiveData || false
 
@@ -78,6 +90,8 @@ export async function initCodeceptGlobals(dir, config, container) {
  * Called from mocha/ui.js pre-require event
  */
 export function initMochaGlobals(context) {
+  if (store.noGlobals) return;
+
   // Mocha test framework globals
   global.BeforeAll = context.BeforeAll
   global.AfterAll = context.AfterAll
@@ -106,6 +120,8 @@ export function getGlobalNames() {
   return [
     'codecept_dir',
     'output_dir',
+    'Helper',
+    'codecept_helper',
     'actor',
     'codecept_actor',
     'Actor',
@@ -117,13 +133,11 @@ export function getGlobalNames() {
     'inject',
     'share',
     'secret',
-    'codecept_debug',
     'codeceptjs',
     'Given',
     'When',
     'Then',
     'DefineParameterType',
-    'debugMode',
     'maskSensitiveData',
     'BeforeAll',
     'AfterAll',
@@ -136,6 +150,5 @@ export function getGlobalNames() {
     'After',
     'Scenario',
     'xScenario',
-    'container'
   ]
 }

package/lib/heal.js

@@ -4,6 +4,7 @@ import colors from 'chalk'
 import recorder from './recorder.js'
 import output from './output.js'
 import event from './event.js'
+import container from './container.js'
 
 /**
  * @class
@@ -48,12 +49,14 @@ class Heal {
   }
 
   hasCorrespondingRecipes(step) {
-    return matchRecipes(this.recipes, this.contextName).filter(r => !r.steps || r.steps.includes(step.name)).length > 0
+    return matchRecipes(this.recipes, this.contextName).filter(r => !r.steps || r.steps.includes(step.title)).length > 0
   }
 
   async getCodeSuggestions(context) {
     const suggestions = []
+    const stepName = context.step?.title
     const recipes = matchRecipes(this.recipes, this.contextName)
+      .filter(r => !r.steps || !stepName || r.steps.includes(stepName))
 
     debug('Recipes', recipes)
 
@@ -69,7 +72,7 @@ class Heal {
       if (!prepareFn) continue
 
       if (context[property]) continue
-      context[property] = await prepareFn(global.inject())
+      context[property] = await prepareFn(container.support())
     }
 
     output.level(currentOutputLevel)
@@ -116,10 +119,10 @@ class Heal {
           })
 
           if (typeof codeSnippet === 'string') {
-            const I = global.container.support('I')
+            const I = container.support('I')
             await eval(codeSnippet)
           } else if (typeof codeSnippet === 'function') {
-            await codeSnippet(global.container.support())
+            await codeSnippet(container.support())
           }
 
           this.fixes.push({

package/lib/helper/ApiDataFactory.js

@@ -1,6 +1,7 @@
 import path from 'path'
 import Helper from '@codeceptjs/helper'
 import REST from './REST.js'
+import store from '../store.js'
 
 /**
  * Helper for managing remote data using REST API.
@@ -324,7 +325,7 @@ class ApiDataFactory extends Helper {
         await import.meta.resolve(modulePath)
       } catch (e) {
         // If not found, try relative to codecept_dir
-        modulePath = path.join(global.codecept_dir, modulePath)
+        modulePath = path.join(store.codeceptDir, modulePath)
       }
       // check if the new syntax `export default new Factory()` is used and loads the builder, otherwise loads the module that used old syntax `module.exports = new Factory()`.
       const module = await import(modulePath)

package/lib/helper/FileSystem.js

@@ -4,6 +4,7 @@ import fs from 'fs'
 
 import Helper from '@codeceptjs/helper'
 import { fileExists } from '../utils.js'
+import store from '../store.js'
 import { fileIncludes } from '../assert/include.js'
 import { fileEquals } from '../assert/equal.js'
 
@@ -33,7 +34,7 @@ import { fileEquals } from '../assert/equal.js'
 class FileSystem extends Helper {
   constructor() {
     super()
-    this.dir = global.codecept_dir
+    this.dir = store.codeceptDir
     this.file = ''
   }
 
@@ -52,7 +53,7 @@ class FileSystem extends Helper {
    * @param {string} openPath
    */
   amInPath(openPath) {
-    this.dir = path.join(global.codecept_dir, openPath)
+    this.dir = path.join(store.codeceptDir, openPath)
     try {
       this.debugSection('Dir', this.dir)
     } catch (e) {

package/lib/helper/GraphQLDataFactory.js

@@ -2,6 +2,7 @@ import path from 'path'
 
 import HelperModule from '@codeceptjs/helper'
 import GraphQL from './GraphQL.js'
+import store from '../store.js'
 
 /**
  * Helper for managing remote data using GraphQL queries.
@@ -251,7 +252,7 @@ class GraphQLDataFactory extends Helper {
       try {
         require.resolve(modulePath)
       } catch (e) {
-        modulePath = path.join(global.codecept_dir, modulePath)
+        modulePath = path.join(store.codeceptDir, modulePath)
       }
       const builder = require(modulePath)
       return builder.build(data)