codeceptjs 4.0.0-beta.7.esm-aria → 4.0.0-beta.9.esm-aria

package/lib/workers.js

@@ -54,16 +54,37 @@ const populateGroups = numberOfWorkers => {
   return groups
 }
 
-const createWorker = workerObject => {
+const createWorker = (workerObject, isPoolMode = false) => {
   const worker = new Worker(pathToWorker, {
     workerData: {
       options: simplifyObject(workerObject.options),
       tests: workerObject.tests,
       testRoot: workerObject.testRoot,
       workerIndex: workerObject.workerIndex + 1,
+      poolMode: isPoolMode,
     },
+    stdout: true,
+    stderr: true,
+  })
+  
+  // Pipe worker stdout/stderr to main process
+  if (worker.stdout) {
+    worker.stdout.setEncoding('utf8')
+    worker.stdout.on('data', (data) => {
+      process.stdout.write(data)
+    })
+  }
+  if (worker.stderr) {
+    worker.stderr.setEncoding('utf8')
+    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}`)
   })
-  worker.on('error', err => output.error(`Worker Error: ${err.stack}`))
 
   WorkerStorage.addWorker(worker)
   return worker
@@ -200,9 +221,31 @@ 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) => {
+      if (cfg.helpers) {
+        cfg.helpers = { ...cfg.helpers }
+        Object.keys(cfg.helpers).forEach(helperName => {
+          if (cfg.helpers[helperName] && cfg.helpers[helperName].customLocatorStrategies !== undefined) {
+            cfg.helpers[helperName] = { ...cfg.helpers[helperName] }
+            delete cfg.helpers[helperName].customLocatorStrategies
+          }
+        })
+      }
+      return cfg
+    }
+    
+    const cleanedOldConfig = cleanConfig(oldConfig)
+    const cleanedNewConfig = cleanConfig(configWithoutFunctions)
+    
     const newConfig = {
-      ...oldConfig,
-      ...config,
+      ...cleanedOldConfig,
+      ...cleanedNewConfig,
     }
     this.options.override = JSON.stringify(newConfig)
   }
@@ -237,15 +280,19 @@ 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.options = config.options || {}
     this.errors = []
     this.numberOfWorkers = 0
     this.closedWorkers = 0
     this.workers = []
     this.testGroups = []
-    this.config = config
-    this.numberOfWorkersRequested = numberOfWorkers
-  // Track emitted pass events to avoid double-counting duplicates from retries/race conditions
-  this._passedUids = new Set()
+    this.testPool = []
+    this.testPoolInitialized = false
+    this.isPoolMode = config.by === 'pool'
+    this.activeWorkers = new Map()
+    this.maxWorkers = numberOfWorkers // Track original worker count for pool mode
 
     createOutputDir(config.testConfig)
     // Defer worker initialization until codecept is ready
@@ -284,6 +331,7 @@ class Workers extends EventEmitter {
    *
    * - `suite`
    * - `test`
+   * - `pool`
    * - function(numberOfWorkers)
    *
    * This method can be overridden for a better split.
@@ -299,7 +347,11 @@ class Workers extends EventEmitter {
         this.testGroups.push(convertToMochaTests(testGroup))
       }
     } else if (typeof numberOfWorkers === 'number' && numberOfWorkers > 0) {
-      this.testGroups = config.by === 'suite' ? this.createGroupsOfSuites(numberOfWorkers) : this.createGroupsOfTests(numberOfWorkers)
+      if (config.by === 'pool') {
+        this.createTestPool(numberOfWorkers)
+      } else {
+        this.testGroups = config.by === 'suite' ? this.createGroupsOfSuites(numberOfWorkers) : this.createGroupsOfTests(numberOfWorkers)
+      }
     }
   }
 
@@ -339,6 +391,62 @@ class Workers extends EventEmitter {
     return groups
   }
 
+  /**
+   * @param {Number} numberOfWorkers
+   */
+  createTestPool(numberOfWorkers) {
+    // For pool mode, create empty groups for each worker and initialize empty pool
+    // Test pool will be populated lazily when getNextTest() is first called
+    this.testPool = []
+    this.testPoolInitialized = false
+    this.testGroups = populateGroups(numberOfWorkers)
+  }
+
+  /**
+   * Initialize the test pool if not already done
+   * This is called lazily to avoid state pollution issues during construction
+   */
+  _initializeTestPool() {
+    if (this.testPoolInitialized) {
+      return
+    }
+
+    // Ensure codecept is initialized
+    if (!this.codecept) {
+      output.log('Warning: codecept not initialized when initializing test pool')
+      this.testPoolInitialized = true
+      return
+    }
+
+    const files = this.codecept.testFiles
+    if (!files || files.length === 0) {
+      this.testPoolInitialized = true
+      return
+    }
+
+    // In ESM, test UIDs are not stable across different mocha instances
+    // So instead of using UIDs, we distribute test FILES
+    // Each file may contain multiple tests
+    for (const file of files) {
+      this.testPool.push(file)
+    }
+    
+    this.testPoolInitialized = true
+  }
+
+  /**
+   * Gets the next test from the pool
+   * @returns {String|null} test file path or null if no tests available
+   */
+  getNextTest() {
+    // Lazy initialization of test pool on first call
+    if (!this.testPoolInitialized) {
+      this._initializeTestPool()
+    }
+    
+    return this.testPool.shift()
+  }
+
   /**
    * @param {Number} numberOfWorkers
    */
@@ -386,12 +494,20 @@ class Workers extends EventEmitter {
     recorder.startUnlessRunning()
     event.dispatcher.emit(event.workers.before)
     process.env.RUNS_WITH_WORKERS = 'true'
-    recorder.add('starting workers', () => {
-      for (const worker of this.workers) {
-        const workerThread = createWorker(worker)
-        this._listenWorkerEvents(workerThread)
-      }
+    
+    // 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 = []
+    for (const worker of this.workers) {
+      const workerThread = createWorker(worker, this.isPoolMode)
+      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)
     })
@@ -412,9 +528,27 @@ class Workers extends EventEmitter {
   }
 
   _listenWorkerEvents(worker) {
+    // Track worker thread for pool mode
+    if (this.isPoolMode) {
+      this.activeWorkers.set(worker, { available: true, workerIndex: null })
+    }
+
     worker.on('message', message => {
       output.process(message.workerIndex)
 
+      // Handle test requests for pool mode
+      if (message.type === 'REQUEST_TEST') {
+        if (this.isPoolMode) {
+          const nextTest = this.getNextTest()
+          if (nextTest) {
+            worker.postMessage({ type: 'TEST_ASSIGNED', test: nextTest })
+          } else {
+            worker.postMessage({ type: 'NO_MORE_TESTS' })
+          }
+        }
+        return
+      }
+
       // deal with events that are not test cycle related
       if (!message.event) {
         return this.emit('message', message)
@@ -423,11 +557,21 @@ class Workers extends EventEmitter {
       switch (message.event) {
         case event.all.result:
           // we ensure consistency of result by adding tests in the very end
-          Container.result().addFailures(message.data.failures)
-          Container.result().addStats(message.data.stats)
-          message.data.tests.forEach(test => {
-            Container.result().addTest(deserializeTest(test))
-          })
+          // Check if message.data.stats is valid before adding
+          if (message.data.stats) {
+            Container.result().addStats(message.data.stats)
+          }
+
+          if (message.data.failures) {
+            Container.result().addFailures(message.data.failures)
+          }
+
+          if (message.data.tests) {
+            message.data.tests.forEach(test => {
+              Container.result().addTest(deserializeTest(test))
+            })
+          }
+
           break
         case event.suite.before:
           this.emit(event.suite.before, deserializeSuite(message.data))
@@ -439,7 +583,12 @@ class Workers extends EventEmitter {
           this.emit(event.test.started, deserializeTest(message.data))
           break
         case event.test.failed:
-          // Skip individual failed events - we'll emit based on finished state
+          // For hook failures, emit immediately as there won't be a test.finished event
+          // Regular test failures are handled via test.finished to support retries
+          if (message.data?.hookName) {
+            this.emit(event.test.failed, deserializeTest(message.data))
+          }
+          // 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  
@@ -493,8 +642,8 @@ class Workers extends EventEmitter {
           this.emit(event.step.failed, message.data, message.data.error)
           break
         case event.hook.failed:
-          // Count hook failures as test failures for event counting
-          this.emit(event.test.failed, { title: `Hook failure: ${message.data.hookName || 'unknown'}`, err: message.data.error })
+          // 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)
           break
       }
@@ -506,7 +655,14 @@ class Workers extends EventEmitter {
 
     worker.on('exit', () => {
       this.closedWorkers += 1
-      if (this.closedWorkers === this.numberOfWorkers) {
+
+      if (this.isPoolMode) {
+        // Pool mode: finish when all workers have exited and no more tests
+        if (this.closedWorkers === this.numberOfWorkers) {
+          this._finishRun()
+        }
+      } else if (this.closedWorkers === this.numberOfWorkers) {
+        // Regular mode: finish when all original workers have exited
         this._finishRun()
       }
     })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "4.0.0-beta.7.esm-aria",
+  "version": "4.0.0-beta.9.esm-aria",
   "type": "module",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
@@ -29,29 +29,39 @@
     "docs/webapi/**"
   ],
   "main": "lib/index.js",
+  "module": "lib/index.js",
+  "types": "typings/index.d.ts",
   "exports": {
-    ".": "./lib/index.js",
+    ".": {
+      "import": "./lib/index.js",
+      "require": "./lib/index.js",
+      "types": "./typings/index.d.ts"
+    },
     "./lib/*": "./lib/*.js",
     "./els": "./lib/els.js",
     "./effects": "./lib/effects.js",
     "./steps": "./lib/steps.js",
     "./store": "./lib/store.js"
   },
-  "types": "typings/index.d.ts",
   "bin": {
     "codeceptjs": "./bin/codecept.js"
   },
   "repository": "Codeception/codeceptjs",
   "scripts": {
-    "json-server": "json-server test/data/rest/db.json --host 0.0.0.0 -p 8010 --watch -m test/data/rest/headers.cjs",
+    "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",
+    "mock-server:start": "node test/mock-server/start-mock-server.js",
+    "mock-server:stop": "kill -9 $(lsof -t -i:3001)",
+    "test:with-mock-server": "npm run mock-server:start && npm test",
     "json-server:graphql": "node test/data/graphql/index.js",
     "lint": "eslint bin/ examples/ lib/ test/ translations/ runok.cjs",
     "lint-fix": "eslint bin/ examples/ lib/ test/ translations/ runok.cjs --fix",
     "prettier": "prettier --config prettier.config.js --write bin/**/*.js lib/**/*.js test/**/*.js translations/**/*.js runok.cjs",
     "docs": "./runok.cjs docs",
     "test:unit": "mocha test/unit --recursive --timeout 10000 --reporter @testomatio/reporter/mocha",
+    "test:rest": "mocha test/rest --recursive --timeout 20000 --reporter @testomatio/reporter/mocha",
     "test:runner": "mocha test/runner --recursive --timeout 10000 --reporter @testomatio/reporter/mocha",
-    "test": "npm run test:unit && npm run test:runner",
+    "test": "npm run test:unit && npm run test:rest && npm run test:runner",
     "test:appium-quick": "mocha test/helper/Appium_test.js --grep 'quick' --reporter @testomatio/reporter/mocha",
     "test:appium-other": "mocha test/helper/Appium_test.js --grep 'second' --reporter @testomatio/reporter/mocha",
     "test:ios:appium-quick": "mocha test/helper/Appium_ios_test.js --grep 'quick' --reporter @testomatio/reporter/mocha",
@@ -76,44 +86,43 @@
   },
   "dependencies": {
     "@codeceptjs/configure": "1.0.6",
-    "@codeceptjs/helper": "^4.0.0-beta.1",
-    "@cucumber/cucumber-expressions": "^18.0.1",
-    "@cucumber/gherkin": "32.1.2",
-    "@cucumber/messages": "27.2.0",
-    "@inquirer/confirm": "^5.1.14",
-    "@inquirer/core": "^10.1.15",
-    "@inquirer/input": "^4.2.1",
-    "@inquirer/prompts": "^7.8.2",
-    "@inquirer/select": "^4.3.1",
+    "@codeceptjs/helper": "2.0.4",
+    "@cucumber/cucumber-expressions": "18",
+    "@cucumber/gherkin": "35.1.0",
+    "@cucumber/messages": "29.0.1",
     "@xmldom/xmldom": "0.9.8",
-    "acorn": "8.14.1",
+    "acorn": "8.15.0",
+    "ai": "^5.0.60",
     "arrify": "3.0.0",
-    "axios": "1.8.4",
+    "axios": "1.12.2",
     "chalk": "4.1.2",
-    "cheerio": "^1.1.0",
+    "cheerio": "^1.0.0",
+    "chokidar": "^4.0.3",
     "commander": "11.1.0",
     "cross-spawn": "7.0.6",
     "css-to-xpath": "0.1.0",
     "csstoxpath": "1.6.0",
-    "envinfo": "7.14.0",
+    "envinfo": "7.20.0",
     "escape-string-regexp": "4.0.0",
     "figures": "3.2.0",
     "fn-args": "4.0.0",
-    "fs-extra": "11.3.0",
-    "fuse.js": "^7.1.0",
-    "glob": "^11.0.3",
+    "fs-extra": "11.3.2",
+    "fuse.js": "^7.0.0",
+    "glob": ">=9.0.0 <12",
     "html-minifier-terser": "7.2.0",
-    "inquirer": "12.9.2",
-    "invisi-data": "^1.1.2",
-    "joi": "17.13.3",
+    "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",
+    "lodash.shuffle": "4.2.0",
     "mkdirp": "3.0.1",
-    "mocha": "11.6.0",
-    "monocart-coverage-reports": "2.12.6",
+    "mocha": "11.7.5",
+    "monocart-coverage-reports": "2.12.9",
     "ms": "2.1.3",
-    "ora": "^8.0.0",
+    "multer": "^2.0.2",
+    "ora-classic": "5.4.2",
     "parse-function": "5.6.10",
     "parse5": "7.3.0",
     "promise-retry": "1.1.1",
@@ -122,60 +131,60 @@
     "uuid": "11.1.0"
   },
   "optionalDependencies": {
-    "@codeceptjs/detox-helper": "1.1.8"
+    "@codeceptjs/detox-helper": "1.1.13"
   },
   "devDependencies": {
-    "@apollo/server": "^4.12.2",
+    "@apollo/server": "^5",
     "@codeceptjs/expect-helper": "^1.0.2",
     "@codeceptjs/mock-request": "0.3.1",
     "@eslint/eslintrc": "3.3.1",
-    "@eslint/js": "9.30.0",
+    "@eslint/js": "9.36.0",
     "@faker-js/faker": "9.8.0",
     "@inquirer/testing": "^2.1.49",
     "@pollyjs/adapter-puppeteer": "6.0.6",
     "@pollyjs/core": "6.0.6",
     "@testomatio/reporter": "^2.3.1",
     "@types/chai": "5.2.2",
-    "@types/inquirer": "9.0.7",
-    "@types/node": "24.0.10",
+    "@types/inquirer": "9.0.9",
+    "@types/node": "^24.9.2",
     "@wdio/sauce-service": "9.12.5",
     "@wdio/selenium-standalone-service": "8.15.0",
-    "@wdio/utils": "9.15.0",
+    "@wdio/utils": "9.20.0",
     "@xmldom/xmldom": "0.9.8",
     "bunosh": "latest",
     "chai": "^4.5.0",
     "chai-as-promised": "7.1.2",
     "chai-subset": "1.6.0",
     "documentation": "14.0.3",
-    "electron": "37.1.0",
-    "eslint": "^9.31.0",
+    "electron": "38.2.0",
+    "eslint": "^9.36.0",
     "eslint-plugin-import": "2.32.0",
     "eslint-plugin-mocha": "11.1.0",
-    "expect": "29.7.0",
-    "express": "5.1.0",
-    "globals": "16.2.0",
-    "graphql": "16.10.0",
+    "expect": "30.2.0",
+    "express": "^5.1.0",
+    "globals": "16.4.0",
+    "graphql": "16.11.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.53.0",
-    "prettier": "^3.6.2",
-    "puppeteer": "24.8.0",
+    "playwright": "1.55.1",
+    "prettier": "^3.3.2",
+    "puppeteer": "24.15.0",
     "qrcode-terminal": "0.12.0",
     "rosie": "2.1.1",
     "runok": "^0.9.3",
-    "semver": "7.7.2",
+    "semver": "7.7.3",
     "sinon": "21.0.0",
     "sinon-chai": "3.7.0",
-    "ts-morph": "26.0.0",
+    "ts-morph": "27.0.2",
     "ts-node": "10.9.2",
-    "tsd": "^0.32.0",
+    "tsd": "^0.33.0",
     "tsd-jsdoc": "2.5.0",
-    "typedoc": "0.28.7",
-    "typedoc-plugin-markdown": "4.7.0",
+    "typedoc": "0.28.13",
+    "typedoc-plugin-markdown": "4.9.0",
     "typescript": "5.8.3",
     "wdio-docker-service": "3.2.1",
     "webdriverio": "9.12.5",
@@ -192,5 +201,8 @@
     "compilerOptions": {
       "strict": false
     }
+  },
+  "overrides": {
+    "tmp": "0.2.5"
   }
 }

package/typings/index.d.ts

@@ -97,7 +97,7 @@ declare namespace CodeceptJS {
      * tests: 'tests/**.test.ts'
      * ```
      */
-    tests: string
+    tests: string | string[]
     /**
      * Where to store failure screenshots, artifacts, etc
      *
@@ -440,7 +440,7 @@ declare namespace CodeceptJS {
   interface IHook {}
   interface IScenario {}
   interface IFeature {
-    (title: string): FeatureConfig
+    (title: string, opts?: { [key: string]: any }): FeatureConfig
   }
   interface CallbackOrder extends Array<any> {}
   interface SupportObject {
@@ -486,6 +486,7 @@ declare namespace CodeceptJS {
     todo: IScenario
   }
   interface Feature extends IFeature {
+    only: IFeature
     skip: IFeature
   }
   interface IData {
@@ -521,11 +522,16 @@ declare namespace CodeceptJS {
   function addStep(step: string, 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>
+
 // Globals
 declare const codecept_dir: string
 declare const output_dir: string
-declare function tryTo(...fn): Promise<boolean>
-declare function retryTo(...fn): Promise<null>
+declare const tryTo: TryTo
+declare const retryTo: RetryTo
+declare const hopeThat: HopeThat
 
 declare const actor: CodeceptJS.actor
 declare const codecept_actor: CodeceptJS.actor
@@ -547,7 +553,7 @@ declare const Given: typeof CodeceptJS.addStep
 declare const When: typeof CodeceptJS.addStep
 declare const Then: typeof CodeceptJS.addStep
 
-declare const Feature: typeof CodeceptJS.Feature
+declare const Feature: CodeceptJS.Feature
 declare const Scenario: CodeceptJS.Scenario
 declare const xScenario: CodeceptJS.IScenario
 declare const xFeature: CodeceptJS.IFeature
@@ -630,9 +636,15 @@ declare namespace Mocha {
 }
 
 declare module 'codeceptjs' {
-  export = codeceptjs
+  export default codeceptjs
 }
 
 declare module '@codeceptjs/helper' {
-  export = CodeceptJS.Helper
+  export default CodeceptJS.Helper
+}
+
+declare module 'codeceptjs/effects' {
+  export const tryTo: TryTo
+  export const retryTo: RetryTo
+  export const hopeThat: HopeThat
 }