codeceptjs 4.0.1-beta.9 → 4.0.1

package/lib/workers.js

@@ -20,6 +20,7 @@ import event from './event.js'
 import { deserializeTest } from './mocha/test.js'
 import { deserializeSuite } from './mocha/suite.js'
 import recorder from './recorder.js'
+import store from './store.js'
 import runHook from './hooks.js'
 import WorkerStorage from './workerStorage.js'
 import { createRuns } from './command/run-multiple/collection.js'
@@ -28,7 +29,7 @@ const pathToWorker = path.join(__dirname, 'command', 'workers', 'runTests.js')
 
 const initializeCodecept = async (configPath, options = {}) => {
   const config = await mainConfig.load(configPath || '.')
-  const codecept = new Codecept(config, options)
+  const codecept = new Codecept(config, { ...options, skipDefaultListeners: true })
   await codecept.init(getTestRoot(configPath))
   codecept.loadTests()
 
@@ -117,11 +118,9 @@ const createWorkerObjects = (testGroups, config, testRoot, options, selectedRuns
   const workersToExecute = []
 
   const currentOutputFolder = config.output
-  let currentMochawesomeReportDir
   let currentMochaJunitReporterFile
 
   if (config.mocha && config.mocha.reporterOptions) {
-    currentMochawesomeReportDir = config.mocha.reporterOptions?.mochawesome.options.reportDir
     currentMochaJunitReporterFile = config.mocha.reporterOptions['mocha-junit-reporter'].options.mochaFile
   }
 
@@ -131,8 +130,6 @@ const createWorkerObjects = (testGroups, config, testRoot, options, selectedRuns
     let workerName = worker.name.replace(':', '_')
     _config.output = `${currentOutputFolder}${separator}${workerName}`
     if (config.mocha && config.mocha.reporterOptions) {
-      _config.mocha.reporterOptions.mochawesome.options.reportDir = `${currentMochawesomeReportDir}${separator}${workerName}`
-
       const _tempArray = currentMochaJunitReporterFile.split(separator)
       _tempArray.splice(
         _tempArray.findIndex(item => item.includes('.xml')),
@@ -224,7 +221,8 @@ class WorkerObject {
     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
+    // since functions cannot be serialized and will be lost, causing workers to have empty strategies.
+    // Note: Only WebDriver helper supports customLocatorStrategies
     const configWithoutFunctions = { ...config }
 
     // Clean both old and new config
@@ -370,6 +368,9 @@ class Workers extends EventEmitter {
     // If Codecept isn't initialized yet, return empty groups as a safe fallback
     if (!this.codecept) return populateGroups(numberOfWorkers)
     const files = this.codecept.testFiles
+    
+    // Create a fresh mocha instance to avoid state pollution
+    Container.createMocha(this.codecept.config.mocha || {}, this.options)
     const mocha = Container.mocha()
     mocha.files = files
     mocha.loadFiles()
@@ -384,6 +385,10 @@ class Workers extends EventEmitter {
         groupCounter++
       }
     })
+    
+    // Clean up after collecting test UIDs
+    mocha.unloadFiles()
+    
     return groups
   }
 
@@ -452,9 +457,12 @@ class Workers extends EventEmitter {
     const files = this.codecept.testFiles
     const groups = populateGroups(numberOfWorkers)
 
+    // Create a fresh mocha instance to avoid state pollution
+    Container.createMocha(this.codecept.config.mocha || {}, this.options)
     const mocha = Container.mocha()
     mocha.files = files
     mocha.loadFiles()
+    
     mocha.suite.suites.forEach(suite => {
       const i = indexOfSmallestElement(groups)
       suite.tests.forEach(test => {
@@ -463,6 +471,10 @@ class Workers extends EventEmitter {
         }
       })
     })
+    
+    // Clean up after collecting test UIDs
+    mocha.unloadFiles()
+    
     return groups
   }
 
@@ -489,6 +501,7 @@ class Workers extends EventEmitter {
     await this._ensureInitialized()
     recorder.startUnlessRunning()
     event.dispatcher.emit(event.workers.before)
+    store.workerMode = true
     process.env.RUNS_WITH_WORKERS = 'true'
 
     // Create workers and set up message handlers immediately (not in recorder queue)
@@ -505,7 +518,9 @@ class Workers extends EventEmitter {
     })
 
     return new Promise(resolve => {
-      this.on('end', resolve)
+      this.on('end', () => {
+        resolve()
+      })
     })
   }
 
@@ -529,7 +544,32 @@ class Workers extends EventEmitter {
       this.activeWorkers.set(worker, { available: true, workerIndex: null })
     }
 
+    // Track last activity time to detect hanging workers
+    let lastActivity = Date.now()
+    let currentTest = null
+    let autoTerminated = false
+    const workerTimeout = process.env.CODECEPT_WORKER_TIMEOUT ? ms(process.env.CODECEPT_WORKER_TIMEOUT) : ms('5m')
+    
+    const timeoutChecker = setInterval(() => {
+      const elapsed = Date.now() - lastActivity
+      if (elapsed > workerTimeout) {
+        console.error(`[Main] Worker appears to be hanging (no activity for ${Math.floor(elapsed/1000)}s). Terminating...`)
+        if (currentTest) {
+          console.error(`[Main] Last test: ${currentTest}`)
+        }
+        clearInterval(timeoutChecker)
+        worker.terminate()
+      }
+    }, 30000) // Check every 30 seconds
+
     worker.on('message', message => {
+      lastActivity = Date.now() // Update activity timestamp
+      
+      // Track current test
+      if (message.event === event.test.started && message.data) {
+        currentTest = message.data.title || message.data.fullTitle
+      }
+      
       output.process(message.workerIndex)
 
       // Handle test requests for pool mode
@@ -568,15 +608,41 @@ class Workers extends EventEmitter {
             })
           }
 
+          const exitTimeout = parseInt(process.env.CODECEPT_AUTO_EXIT_TIMEOUT, 10)
+          if (exitTimeout === 0) break
+          setTimeout(() => {
+            autoTerminated = true
+            worker.terminate()
+          }, exitTimeout || 2000)
+
           break
         case event.suite.before:
-          this.emit(event.suite.before, deserializeSuite(message.data))
+          {
+            const suite = deserializeSuite(message.data)
+            this.emit(event.suite.before, suite)
+            event.dispatcher.emit(event.suite.before, suite)
+          }
+          break
+        case event.suite.after:
+          {
+            const suite = deserializeSuite(message.data)
+            this.emit(event.suite.after, suite)
+            event.dispatcher.emit(event.suite.after, suite)
+          }
           break
         case event.test.before:
-          this.emit(event.test.before, deserializeTest(message.data))
+          {
+            const test = deserializeTest(message.data)
+            this.emit(event.test.before, test)
+            event.dispatcher.emit(event.test.before, test)
+          }
           break
         case event.test.started:
-          this.emit(event.test.started, deserializeTest(message.data))
+          {
+            const test = deserializeTest(message.data)
+            this.emit(event.test.started, test)
+            event.dispatcher.emit(event.test.started, test)
+          }
           break
         case event.test.failed:
           // For hook failures, emit immediately as there won't be a test.finished event
@@ -590,7 +656,11 @@ class Workers extends EventEmitter {
           // Skip individual passed events - we'll emit based on finished state
           break
         case event.test.skipped:
-          this.emit(event.test.skipped, deserializeTest(message.data))
+          {
+            const test = deserializeTest(message.data)
+            this.emit(event.test.skipped, test)
+            event.dispatcher.emit(event.test.skipped, test)
+          }
           break
         case event.test.finished:
           // Handle different types of test completion properly
@@ -604,7 +674,7 @@ class Workers extends EventEmitter {
               if (!this._testStates) this._testStates = new Map()
 
               if (!this._testStates.has(uid)) {
-                this._testStates.set(uid, { states: [], lastData: data })
+                this._testStates.set(uid, { states: [], lastData: data, workerIndex: message.workerIndex })
               }
 
               const testState = this._testStates.get(uid)
@@ -619,39 +689,72 @@ class Workers extends EventEmitter {
               }
             }
 
-            this.emit(event.test.finished, deserializeTest(data))
+            const test = deserializeTest(data)
+            this.emit(event.test.finished, test)
+            event.dispatcher.emit(event.test.finished, test)
           }
           break
         case event.test.after:
-          this.emit(event.test.after, deserializeTest(message.data))
+          {
+            const test = deserializeTest(message.data)
+            this.emit(event.test.after, test)
+            event.dispatcher.emit(event.test.after, test)
+          }
           break
         case event.step.finished:
           this.emit(event.step.finished, message.data)
+          event.dispatcher.emit(event.step.finished, message.data)
           break
         case event.step.started:
           this.emit(event.step.started, message.data)
+          event.dispatcher.emit(event.step.started, message.data)
           break
         case event.step.passed:
           this.emit(event.step.passed, message.data)
+          event.dispatcher.emit(event.step.passed, message.data)
           break
         case event.step.failed:
           this.emit(event.step.failed, message.data, message.data.error)
+          event.dispatcher.emit(event.step.failed, message.data, message.data.error)
           break
         case event.hook.failed:
           // Hook failures are already reported as test failures by the worker
           // Just emit the hook.failed event for listeners
           this.emit(event.hook.failed, message.data)
+          event.dispatcher.emit(event.hook.failed, message.data)
+          break
+        case event.hook.passed:
+          this.emit(event.hook.passed, message.data)
+          event.dispatcher.emit(event.hook.passed, message.data)
+          break
+        case event.hook.finished:
+          this.emit(event.hook.finished, message.data)
+          event.dispatcher.emit(event.hook.finished, message.data)
           break
       }
     })
 
     worker.on('error', err => {
+      console.error(`[Main] Worker error:`, err.message || err)
+      if (currentTest) {
+        console.error(`[Main] Failed during test: ${currentTest}`)
+      }
       this.errors.push(err)
     })
 
-    worker.on('exit', () => {
+    worker.on('exit', (code) => {
+      clearInterval(timeoutChecker)
       this.closedWorkers += 1
 
+      if (code !== 0 && !autoTerminated) {
+        console.error(`[Main] Worker exited with code ${code}`)
+        if (currentTest) {
+          console.error(`[Main] Last test running: ${currentTest}`)
+        }
+        // Mark as failed
+        process.exitCode = 1
+      }
+
       if (this.isPoolMode) {
         // Pool mode: finish when all workers have exited and no more tests
         if (this.closedWorkers === this.numberOfWorkers) {
@@ -666,7 +769,7 @@ class Workers extends EventEmitter {
 
   _finishRun() {
     event.dispatcher.emit(event.workers.after, { tests: this.workers.map(worker => worker.tests) })
-    if (Container.result().hasFailed) {
+    if (Container.result().hasFailed || this.errors.length > 0) {
       process.exitCode = 1
     } else {
       process.exitCode = 0
@@ -674,7 +777,10 @@ class Workers extends EventEmitter {
 
     // Emit states for all tracked tests before emitting results
     if (this._testStates) {
-      for (const [uid, { states, lastData }] of this._testStates) {
+      for (const [uid, { states, lastData, workerIndex }] of this._testStates) {
+        // Set correct worker index for output
+        output.process(workerIndex)
+
         // For tests with retries configured, emit all failures + final success
         // For tests without retries, emit only final state
         const lastState = states[states.length - 1]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "4.0.1-beta.9",
+  "version": "4.0.1",
   "type": "module",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
@@ -26,7 +26,9 @@
     "lib",
     "translations",
     "typings/**/*.d.ts",
-    "docs/webapi/**"
+    "docs/*.md",
+    "docs/helpers/**",
+    "docs/plugins/**"
   ],
   "main": "lib/index.js",
   "module": "lib/index.js",
@@ -41,12 +43,15 @@
     "./els": "./lib/els.js",
     "./effects": "./lib/effects.js",
     "./steps": "./lib/steps.js",
-    "./store": "./lib/store.js"
+    "./store": "./lib/store.js",
+    "./assertions": "./lib/assertions.js"
   },
   "bin": {
-    "codeceptjs": "./bin/codecept.js"
+    "codeceptjs": "./bin/codecept.js",
+    "codeceptjs-mcp": "./bin/mcp-server.js",
+    "codeceptq": "./bin/codeceptq.js"
   },
-  "repository": "Codeception/codeceptjs",
+  "repository": "codeceptjs/CodeceptJS",
   "scripts": {
     "test-server": "node bin/test-server.js test/data/rest/db.json --host 0.0.0.0 -p 8010 --read-only",
     "test-server:writable": "node bin/test-server.js test/data/rest/db.json --host 0.0.0.0 -p 8010",
@@ -85,34 +90,34 @@
     "publish-beta": "./runok.cjs publish:next-beta-version"
   },
   "dependencies": {
-    "@codeceptjs/configure": "1.0.6",
+    "@codeceptjs/configure": "^4.0.0-beta.4",
     "@codeceptjs/helper": "2.0.4",
     "@cucumber/cucumber-expressions": "18",
-    "@cucumber/gherkin": "35.1.0",
-    "@cucumber/messages": "29.0.1",
+    "@cucumber/gherkin": "38.0.0",
+    "@cucumber/messages": "32.0.1",
+    "@modelcontextprotocol/sdk": "^1.26.0",
     "@xmldom/xmldom": "0.9.8",
     "acorn": "8.15.0",
-    "ai": "^5.0.60",
+    "ai": "^6.0.43",
     "arrify": "3.0.0",
-    "axios": "1.12.2",
+    "axios": "1.13.2",
     "chalk": "4.1.2",
     "cheerio": "^1.0.0",
-    "chokidar": "^4.0.3",
-    "commander": "11.1.0",
+    "chokidar": "^5.0.0",
+    "commander": "14.0.3",
     "cross-spawn": "7.0.6",
     "css-to-xpath": "0.1.0",
     "csstoxpath": "1.6.0",
-    "envinfo": "7.20.0",
+    "envinfo": "7.21.0",
     "escape-string-regexp": "4.0.0",
     "figures": "3.2.0",
     "fn-args": "4.0.0",
-    "fs-extra": "11.3.2",
+    "fs-extra": "11.3.3",
     "fuse.js": "^7.0.0",
-    "glob": ">=9.0.0 <12",
+    "glob": ">=9.0.0 <14",
     "html-minifier-terser": "7.2.0",
     "inquirer": "^8.2.7",
     "invisi-data": "^1.0.0",
-    "joi": "18.0.1",
     "js-beautify": "1.15.4",
     "lodash.clonedeep": "4.5.0",
     "lodash.merge": "4.6.2",
@@ -126,71 +131,70 @@
     "parse-function": "5.6.10",
     "parse5": "7.3.0",
     "promise-retry": "1.1.1",
-    "resq": "1.11.0",
     "sprintf-js": "1.1.3",
-    "uuid": "11.1.0"
+    "uuid": "11.1.0",
+    "xpath": "0.0.34",
+    "zod": "^4.1.11"
   },
   "optionalDependencies": {
     "@codeceptjs/detox-helper": "1.1.13"
   },
   "devDependencies": {
     "@apollo/server": "^5",
-    "@codeceptjs/expect-helper": "^1.0.2",
+    "@codeceptjs/expect-helper": "^4.0.0-beta.5",
     "@codeceptjs/mock-request": "0.3.1",
-    "@eslint/eslintrc": "3.3.1",
-    "@eslint/js": "9.36.0",
-    "@faker-js/faker": "9.8.0",
-    "@inquirer/testing": "^2.1.49",
+    "@eslint/eslintrc": "3.3.3",
+    "@eslint/js": "9.39.2",
+    "@faker-js/faker": "10.2.0",
+    "@inquirer/testing": "^3.0.3",
     "@pollyjs/adapter-puppeteer": "6.0.6",
     "@pollyjs/core": "6.0.6",
     "@testomatio/reporter": "^2.3.1",
-    "@types/chai": "5.2.2",
+    "@types/chai": "5.2.3",
     "@types/inquirer": "9.0.9",
-    "@types/node": "^24.9.2",
+    "@types/node": "^25.0.3",
     "@wdio/sauce-service": "9.12.5",
     "@wdio/selenium-standalone-service": "8.15.0",
-    "@wdio/utils": "9.20.0",
+    "@wdio/utils": "9.23.3",
     "@xmldom/xmldom": "0.9.8",
     "bunosh": "latest",
-    "chai": "^4.5.0",
-    "chai-as-promised": "7.1.2",
+    "chai": "^6.2.1",
+    "chai-as-promised": "^8.0.2",
     "chai-subset": "1.6.0",
     "documentation": "14.0.3",
-    "electron": "38.2.0",
+    "electron": "40.1.0",
     "eslint": "^9.36.0",
     "eslint-plugin-import": "2.32.0",
-    "eslint-plugin-mocha": "11.1.0",
+    "eslint-plugin-mocha": "11.2.0",
     "expect": "30.2.0",
     "express": "^5.1.0",
-    "globals": "16.4.0",
-    "graphql": "16.11.0",
+    "globals": "17.3.0",
+    "graphql": "16.12.0",
     "graphql-tag": "^2.12.6",
     "husky": "9.1.7",
     "jsdoc": "^3.6.11",
     "jsdoc-typeof-plugin": "1.0.0",
     "json-server": "0.17.4",
-    "mochawesome": "^7.1.3",
-    "playwright": "1.55.1",
+    "playwright": "^1.59.0",
     "prettier": "^3.3.2",
-    "puppeteer": "24.15.0",
+    "puppeteer": "24.36.0",
     "qrcode-terminal": "0.12.0",
     "rosie": "2.1.1",
     "runok": "^0.9.3",
     "semver": "7.7.3",
-    "sinon": "21.0.0",
-    "sinon-chai": "3.7.0",
+    "sinon": "21.0.1",
+    "sinon-chai": "^4.0.1",
     "ts-morph": "27.0.2",
     "ts-node": "10.9.2",
     "tsd": "^0.33.0",
     "tsd-jsdoc": "2.5.0",
     "tsx": "^4.19.2",
-    "typedoc": "0.28.13",
+    "typedoc": "0.28.16",
     "typedoc-plugin-markdown": "4.9.0",
-    "typescript": "5.8.3",
+    "typescript": "5.9.3",
     "wdio-docker-service": "3.2.1",
-    "webdriverio": "9.12.5",
-    "xml2js": "0.6.2",
-    "xpath": "0.0.34"
+    "webdriverio": "9.23.0",
+    "xml2js": "0.6.2"
   },
   "peerDependencies": {
     "tsx": "^4.0.0"
@@ -212,6 +216,7 @@
     }
   },
   "overrides": {
-    "tmp": "0.2.5"
+    "tmp": "0.2.5",
+    "js-yaml": "^4.1.1"
   }
 }

package/typings/index.d.ts

@@ -4,7 +4,6 @@
 /// <reference path="./promiseBasedTypes.d.ts" />
 /// <reference types="webdriverio" />
 /// <reference path="./Mocha.d.ts" />
-/// <reference types="joi" />
 /// <reference types="playwright" />
 
 declare namespace CodeceptJS {
@@ -211,9 +210,6 @@ declare namespace CodeceptJS {
        */
       JSONResponse?: any
 
-      /** Enable AI features for development purposes */
-      AI?: any
-
       [key: string]: any
     }
     /**
@@ -465,7 +461,6 @@ declare namespace CodeceptJS {
     | { ios: string }
     | { android: string; ios: string }
     | { react: string }
-    | { vue: string }
     | { shadow: string[] }
     | { custom: string }
     | { pw: string }
@@ -519,12 +514,12 @@ declare namespace CodeceptJS {
     retry(retries?: number): HookConfig
   }
 
-  function addStep(step: string, fn: Function): Promise<void>
+  function addStep(step: string | RegExp, fn: Function): Promise<void>
 }
 
-type TryTo = <T>(fn: () => Promise<T> | T) => Promise<T | false>
-type HopeThat = <T>(fn: () => Promise<T> | T) => Promise<T | false>
-type RetryTo = <T>(fn: () => Promise<T> | T, retries?: number) => Promise<T>
+type TryTo = (fn: () => void) => Promise<boolean>
+type HopeThat = (fn: () => void) => Promise<boolean>
+type RetryTo = (fn: (tries: number) => Promise<void> | void, maxTries: number, pollInterval?: number) => Promise<boolean>
 
 // Globals
 declare const codecept_dir: string
@@ -635,8 +630,105 @@ declare namespace Mocha {
   }
 }
 
+// Internal API types
 declare module 'codeceptjs' {
   export default codeceptjs
+
+  /**
+   * Dependency Injection Container
+   * Provides access to helpers, support objects, plugins, and translation
+   */
+  export const container: typeof CodeceptJS.Container
+
+  /**
+   * Test runner class
+   */
+  export const codecept: typeof CodeceptJS.Codecept
+
+  /**
+   * Output module for printing messages
+   */
+  export const output: typeof CodeceptJS.output
+
+  /**
+   * Event dispatcher for listening to CodeceptJS events
+   */
+  export const event: typeof CodeceptJS.event
+
+  /**
+   * Global promise chain recorder
+   */
+  export const recorder: CodeceptJS.recorder
+
+  /**
+   * Configuration module
+   */
+  export const config: typeof CodeceptJS.Config
+
+  /**
+   * Actor (I) constructor
+   */
+  export const actor: CodeceptJS.actor
+
+  /**
+   * Base Helper class
+   */
+  export const helper: typeof CodeceptJS.Helper
+
+  /**
+   * Pause execution until user input
+   */
+  export const pause: typeof CodeceptJS.pause
+
+  /**
+   * Execute steps within specific context
+   */
+  export const within: typeof CodeceptJS.within
+
+  /**
+   * Create data tables for data-driven tests
+   */
+  export const dataTable: typeof CodeceptJS.DataTable
+
+  /**
+   * Create data table arguments
+   */
+  export const dataTableArgument: typeof CodeceptJS.DataTableArgument
+
+  /**
+   * Shared store for test data
+   */
+  export const store: typeof CodeceptJS.store
+
+  /**
+   * Locator builder
+   */
+  export const locator: typeof CodeceptJS.Locator
+
+  /**
+   * Auto-healing module
+   */
+  export const heal: any
+
+  /**
+   * AI assistant module
+   */
+  export const ai: any
+
+  /**
+   * Workers for parallel execution
+   */
+  export const Workers: any
+
+  /**
+   * Secret value type for sensitive data
+   */
+  export const Secret: typeof CodeceptJS.Secret
+
+  /**
+   * Create a secret value
+   */
+  export const secret: typeof CodeceptJS.Secret.secret
 }
 
 declare module '@codeceptjs/helper' {
@@ -648,3 +740,22 @@ declare module 'codeceptjs/effects' {
   export const retryTo: RetryTo
   export const hopeThat: HopeThat
 }
+
+declare module 'codeceptjs/steps' {
+  const step: {
+    opts(opts: CodeceptJS.StepOptions): CodeceptJS.StepConfig;
+    timeout(timeout: number): CodeceptJS.StepConfig;
+    retry(retry: number): CodeceptJS.StepConfig;
+    stepOpts(opts: CodeceptJS.StepOptions): CodeceptJS.StepConfig;
+    stepTimeout(timeout: number): CodeceptJS.StepConfig;
+    stepRetry(retry: number): CodeceptJS.StepConfig;
+    section(name: string): any;
+    endSection(): any;
+    Section(name: string): any;
+    EndSection(): any;
+    Given(): any;
+    When(): any;
+    Then(): any;
+  }
+  export default step
+}