codeceptjs 3.7.5-beta.8 → 3.7.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.7.5-beta.8",
+  "version": "3.7.5",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -78,12 +78,12 @@
     "@codeceptjs/configure": "1.0.6",
     "@codeceptjs/helper": "2.0.4",
     "@cucumber/cucumber-expressions": "18",
-    "@cucumber/gherkin": "32.1.2",
-    "@cucumber/messages": "27.2.0",
+    "@cucumber/gherkin": "35.1.0",
+    "@cucumber/messages": "29.0.1",
     "@xmldom/xmldom": "0.9.8",
-    "acorn": "8.14.1",
+    "acorn": "8.15.0",
     "arrify": "3.0.0",
-    "axios": "1.11.0",
+    "axios": "1.12.2",
     "chalk": "4.1.2",
     "cheerio": "^1.0.0",
     "chokidar": "^4.0.3",
@@ -95,20 +95,20 @@
     "escape-string-regexp": "4.0.0",
     "figures": "3.2.0",
     "fn-args": "4.0.0",
-    "fs-extra": "11.3.0",
+    "fs-extra": "11.3.2",
     "fuse.js": "^7.0.0",
     "glob": ">=9.0.0 <12",
     "html-minifier-terser": "7.2.0",
     "inquirer": "^8.2.7",
     "invisi-data": "^1.0.0",
-    "joi": "17.13.3",
+    "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.2",
+    "monocart-coverage-reports": "2.12.9",
     "ms": "2.1.3",
     "multer": "^2.0.2",
     "ora-classic": "5.4.2",
@@ -120,20 +120,20 @@
     "uuid": "11.1.0"
   },
   "optionalDependencies": {
-    "@codeceptjs/detox-helper": "1.1.8"
+    "@codeceptjs/detox-helper": "1.1.12"
   },
   "devDependencies": {
-    "@apollo/server": "^4",
+    "@apollo/server": "^5",
     "@codeceptjs/expect-helper": "^1.0.2",
     "@codeceptjs/mock-request": "0.3.1",
     "@eslint/eslintrc": "3.3.1",
-    "@eslint/js": "9.34.0",
+    "@eslint/js": "9.36.0",
     "@faker-js/faker": "9.8.0",
     "@pollyjs/adapter-puppeteer": "6.0.6",
     "@pollyjs/core": "6.0.6",
     "@types/chai": "5.2.2",
-    "@types/inquirer": "9.0.7",
-    "@types/node": "24.0.10",
+    "@types/inquirer": "9.0.9",
+    "@types/node": "24.5.2",
     "@wdio/sauce-service": "9.12.5",
     "@wdio/selenium-standalone-service": "8.15.0",
     "@wdio/utils": "9.15.0",
@@ -142,13 +142,13 @@
     "chai-as-promised": "7.1.2",
     "chai-subset": "1.6.0",
     "documentation": "14.0.3",
-    "electron": "37.2.3",
-    "eslint": "^9.24.0",
+    "electron": "38.1.2",
+    "eslint": "^9.36.0",
     "eslint-plugin-import": "2.32.0",
     "eslint-plugin-mocha": "11.1.0",
-    "expect": "30.0.5",
+    "expect": "30.1.2",
     "express": "^5.1.0",
-    "globals": "16.2.0",
+    "globals": "16.4.0",
     "graphql": "16.11.0",
     "graphql-tag": "^2.12.6",
     "husky": "9.1.7",
@@ -157,7 +157,7 @@
     "jsdoc-typeof-plugin": "1.0.0",
     "json-server": "0.17.4",
     "mochawesome": "^7.1.3",
-    "playwright": "1.54.1",
+    "playwright": "1.55.0",
     "prettier": "^3.3.2",
     "puppeteer": "24.15.0",
     "qrcode-terminal": "0.12.0",
@@ -171,8 +171,8 @@
     "ts-node": "10.9.2",
     "tsd": "^0.33.0",
     "tsd-jsdoc": "2.5.0",
-    "typedoc": "0.28.10",
-    "typedoc-plugin-markdown": "4.8.1",
+    "typedoc": "0.28.13",
+    "typedoc-plugin-markdown": "4.9.0",
     "typescript": "5.8.3",
     "wdio-docker-service": "3.2.1",
     "webdriverio": "9.12.5",
@@ -189,5 +189,8 @@
     "compilerOptions": {
       "strict": false
     }
+  },
+  "overrides": {
+    "tmp": "0.2.5"
   }
 }

package/typings/promiseBasedTypes.d.ts

@@ -2735,9 +2735,6 @@ declare namespace CodeceptJS {
      * @property [testIdAttribute = data-testid] - locate elements based on the testIdAttribute. See more of [locate by test id](https://playwright.dev/docs/locators#locate-by-test-id).
      * @property [customLocatorStrategies] - custom locator strategies. An object with keys as strategy names and values as JavaScript functions. Example: `{ byRole: (selector, root) => { return root.querySelector(\`[role="\${selector}\"]\`) } }`
      */
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type PlaywrightConfig = {
         url?: string;
         browser?: 'chromium' | 'firefox' | 'webkit' | 'electron';
@@ -6115,9 +6112,6 @@ declare namespace CodeceptJS {
      * @property [chrome] - pass additional [Puppeteer run options](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#puppeteerlaunchoptions).
      * @property [highlightElement] - highlight the interacting elements. Default: false. Note: only activate under verbose mode (--verbose).
      */
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type PuppeteerConfig = {
         url: string;
         basicAuth?: any;
@@ -6541,6 +6535,17 @@ declare namespace CodeceptJS {
          * {{ react }}
          */
         _locate(): Promise<any>;
+        /**
+         * Get single element by different locator types, including strict locator
+         * Should be used in custom helpers:
+         *
+         * ```js
+         * const element = await this.helpers['Puppeteer']._locateElement({name: 'password'});
+         * ```
+         *
+         * {{ react }}
+         */
+        _locateElement(): Promise<any>;
         /**
          * Find a checkbox by providing human-readable text:
          * NOTE: Assumes the checkable element exists
@@ -6577,6 +6582,17 @@ declare namespace CodeceptJS {
          * @returns WebElement of being used Web helper
          */
         grabWebElements(locator: CodeceptJS.LocatorOrString): Promise<any>;
+        /**
+         * Grab WebElement for given locator
+         * Resumes test execution, so **should be used inside an async function with `await`** operator.
+         *
+         * ```js
+         * const webElement = await I.grabWebElement('#button');
+         * ```
+         * @param locator - element located by CSS|XPath|strict locator.
+         * @returns WebElement of being used Web helper
+         */
+        grabWebElement(locator: CodeceptJS.LocatorOrString): Promise<any>;
         /**
          * Switch focus to a particular tab by its number. It waits tabs loading and then switch tab
          *
@@ -7912,6 +7928,22 @@ declare namespace CodeceptJS {
          */
         flushWebSocketMessages(): Promise<any>;
     }
+    /**
+     * Find elements using Puppeteer's native element discovery methods
+     * Note: Unlike Playwright, Puppeteer's Locator API doesn't have .all() method for multiple elements
+     * @param matcher - Puppeteer context to search within
+     * @param locator - Locator specification
+     * @returns Array of ElementHandle objects
+     */
+    function findElements(matcher: any, locator: any | string): Promise<any[]>;
+    /**
+     * Find a single element using Puppeteer's native element discovery methods
+     * Note: Puppeteer Locator API doesn't have .first() method like Playwright
+     * @param matcher - Puppeteer context to search within
+     * @param locator - Locator specification
+     * @returns Single ElementHandle object
+     */
+    function findElement(matcher: any, locator: any | string): Promise<object>;
     /**
      * ## Configuration
      * @property [endpoint] - API base URL
@@ -7924,9 +7956,6 @@ declare namespace CodeceptJS {
      * @property [onResponse] - an async function which can update response object.
      * @property [maxUploadFileSize] - set the max content file size in MB when performing api calls.
      */
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type RESTConfig = {
         endpoint?: string;
         prettyPrintJson?: boolean;
@@ -9072,9 +9101,6 @@ declare namespace CodeceptJS {
      * @property [highlightElement] - highlight the interacting elements. Default: false. Note: only activate under verbose mode (--verbose).
      * @property [logLevel = silent] - level of logging verbosity. Default: silent. Options: trace | debug | info | warn | error | silent. More info: https://webdriver.io/docs/configuration/#loglevel
      */
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type WebDriverConfig = {
         url: string;
         browser: string;
@@ -9545,6 +9571,17 @@ declare namespace CodeceptJS {
          * @returns WebElement of being used Web helper
          */
         grabWebElements(locator: CodeceptJS.LocatorOrString): Promise<any>;
+        /**
+         * Grab WebElement for given locator
+         * Resumes test execution, so **should be used inside an async function with `await`** operator.
+         *
+         * ```js
+         * const webElement = await I.grabWebElement('#button');
+         * ```
+         * @param locator - element located by CSS|XPath|strict locator.
+         * @returns WebElement of being used Web helper
+         */
+        grabWebElement(locator: CodeceptJS.LocatorOrString): Promise<any>;
         /**
          * Set [WebDriver timeouts](https://webdriver.io/docs/timeouts.html) in realtime.
          *

package/typings/types.d.ts

@@ -2825,9 +2825,6 @@ declare namespace CodeceptJS {
      * @property [testIdAttribute = data-testid] - locate elements based on the testIdAttribute. See more of [locate by test id](https://playwright.dev/docs/locators#locate-by-test-id).
      * @property [customLocatorStrategies] - custom locator strategies. An object with keys as strategy names and values as JavaScript functions. Example: `{ byRole: (selector, root) => { return root.querySelector(\`[role="\${selector}\"]\`) } }`
      */
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type PlaywrightConfig = {
         url?: string;
         browser?: 'chromium' | 'firefox' | 'webkit' | 'electron';
@@ -6356,9 +6353,6 @@ declare namespace CodeceptJS {
      * @property [chrome] - pass additional [Puppeteer run options](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#puppeteerlaunchoptions).
      * @property [highlightElement] - highlight the interacting elements. Default: false. Note: only activate under verbose mode (--verbose).
      */
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type PuppeteerConfig = {
         url: string;
         basicAuth?: any;
@@ -6798,6 +6792,17 @@ declare namespace CodeceptJS {
          * {{ react }}
          */
         _locate(): void;
+        /**
+         * Get single element by different locator types, including strict locator
+         * Should be used in custom helpers:
+         *
+         * ```js
+         * const element = await this.helpers['Puppeteer']._locateElement({name: 'password'});
+         * ```
+         *
+         * {{ react }}
+         */
+        _locateElement(): void;
         /**
          * Find a checkbox by providing human-readable text:
          * NOTE: Assumes the checkable element exists
@@ -6834,6 +6839,17 @@ declare namespace CodeceptJS {
          * @returns WebElement of being used Web helper
          */
         grabWebElements(locator: CodeceptJS.LocatorOrString): Promise<any>;
+        /**
+         * Grab WebElement for given locator
+         * Resumes test execution, so **should be used inside an async function with `await`** operator.
+         *
+         * ```js
+         * const webElement = await I.grabWebElement('#button');
+         * ```
+         * @param locator - element located by CSS|XPath|strict locator.
+         * @returns WebElement of being used Web helper
+         */
+        grabWebElement(locator: CodeceptJS.LocatorOrString): Promise<any>;
         /**
          * Switch focus to a particular tab by its number. It waits tabs loading and then switch tab
          *
@@ -8289,6 +8305,22 @@ declare namespace CodeceptJS {
          */
         flushWebSocketMessages(): void;
     }
+    /**
+     * Find elements using Puppeteer's native element discovery methods
+     * Note: Unlike Playwright, Puppeteer's Locator API doesn't have .all() method for multiple elements
+     * @param matcher - Puppeteer context to search within
+     * @param locator - Locator specification
+     * @returns Array of ElementHandle objects
+     */
+    function findElements(matcher: any, locator: any | string): Promise<any[]>;
+    /**
+     * Find a single element using Puppeteer's native element discovery methods
+     * Note: Puppeteer Locator API doesn't have .first() method like Playwright
+     * @param matcher - Puppeteer context to search within
+     * @param locator - Locator specification
+     * @returns Single ElementHandle object
+     */
+    function findElement(matcher: any, locator: any | string): Promise<object>;
     /**
      * ## Configuration
      * @property [endpoint] - API base URL
@@ -8301,9 +8333,6 @@ declare namespace CodeceptJS {
      * @property [onResponse] - an async function which can update response object.
      * @property [maxUploadFileSize] - set the max content file size in MB when performing api calls.
      */
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type RESTConfig = {
         endpoint?: string;
         prettyPrintJson?: boolean;
@@ -9509,9 +9538,6 @@ declare namespace CodeceptJS {
      * @property [highlightElement] - highlight the interacting elements. Default: false. Note: only activate under verbose mode (--verbose).
      * @property [logLevel = silent] - level of logging verbosity. Default: silent. Options: trace | debug | info | warn | error | silent. More info: https://webdriver.io/docs/configuration/#loglevel
      */
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type WebDriverConfig = {
         url: string;
         browser: string;
@@ -9982,6 +10008,17 @@ declare namespace CodeceptJS {
          * @returns WebElement of being used Web helper
          */
         grabWebElements(locator: CodeceptJS.LocatorOrString): Promise<any>;
+        /**
+         * Grab WebElement for given locator
+         * Resumes test execution, so **should be used inside an async function with `await`** operator.
+         *
+         * ```js
+         * const webElement = await I.grabWebElement('#button');
+         * ```
+         * @param locator - element located by CSS|XPath|strict locator.
+         * @returns WebElement of being used Web helper
+         */
+        grabWebElement(locator: CodeceptJS.LocatorOrString): Promise<any>;
         /**
          * Set [WebDriver timeouts](https://webdriver.io/docs/timeouts.html) in realtime.
          *
@@ -11526,6 +11563,13 @@ declare namespace CodeceptJS {
          * Loads tests by pattern or by config.tests
          */
         loadTests(pattern?: string): void;
+        /**
+         * Apply sharding to test files based on shard configuration
+         * @param testFiles - Array of test file paths
+         * @param shardConfig - Shard configuration in format "index/total" (e.g., "1/4")
+         * @returns - Filtered array of test files for this shard
+         */
+        _applySharding(testFiles: string[], shardConfig: string): string[];
         /**
          * Run a specific test or all loaded tests.
          */
@@ -12019,6 +12063,10 @@ declare namespace CodeceptJS {
          * Get a state of current queue and tasks
          */
         toString(): string;
+        /**
+         * Get current session ID
+         */
+        getCurrentSessionId(): string | null;
     }
     interface RecorderSession {
         running: boolean;

package/lib/command/run-failed-tests.js

@@ -1,218 +0,0 @@
-const fs = require('fs')
-const path = require('path')
-const { getConfig, printError, getTestRoot, createOutputDir } = require('./utils')
-const Config = require('../config')
-const store = require('../store')
-const Codecept = require('../codecept')
-const output = require('../output')
-const Workers = require('../workers')
-const { tryOrDefault } = require('../utils')
-
-module.exports = async function (options) {
-  // registering options globally to use in config
-  if (options.profile) {
-    process.env.profile = options.profile
-  }
-  if (options.verbose || options.debug) store.debugMode = true
-
-  const configFile = options.config
-  let config = getConfig(configFile)
-  
-  if (options.override) {
-    config = Config.append(JSON.parse(options.override))
-  }
-  
-  const testRoot = getTestRoot(configFile)
-  createOutputDir(config, testRoot)
-
-  // Determine failed tests file path - respect CodeceptJS output directory
-  const failedTestsFile = options.file || 'failed-tests.json'
-  const failedTestsPath = path.isAbsolute(failedTestsFile)
-    ? failedTestsFile
-    : path.resolve(global.output_dir || './output', failedTestsFile)
-
-  // Check if failed tests file exists
-  if (!fs.existsSync(failedTestsPath)) {
-    output.error(`Failed tests file not found: ${failedTestsPath}`)
-    output.print('Run tests first to generate a failed tests file, or specify a different file with --file option')
-    process.exitCode = 1
-    return
-  }
-
-  let failedTestsData
-  try {
-    const fileContent = fs.readFileSync(failedTestsPath, 'utf8')
-    failedTestsData = JSON.parse(fileContent)
-  } catch (error) {
-    output.error(`Failed to read or parse failed tests file: ${error.message}`)
-    process.exitCode = 1
-    return
-  }
-
-  if (!failedTestsData.tests || failedTestsData.tests.length === 0) {
-    output.print('No failed tests found in the file')
-    return
-  }
-
-  output.print(`Found ${failedTestsData.tests.length} failed tests from ${failedTestsData.timestamp}`)
-
-  // Build test patterns from failed tests
-  const testPatterns = []
-  const testsByFile = new Map()
-
-  // Group tests by file for more efficient execution
-  failedTestsData.tests.forEach(test => {
-    if (test.file) {
-      if (!testsByFile.has(test.file)) {
-        testsByFile.set(test.file, [])
-      }
-      testsByFile.get(test.file).push(test)
-    }
-  })
-
-  // If we have specific test files, use them
-  if (testsByFile.size > 0) {
-    for (const [file, tests] of testsByFile) {
-      if (options.grep) {
-        // If grep is specified, combine with file pattern
-        testPatterns.push(file)
-      } else {
-        // Try to be more specific with test titles if possible
-        testPatterns.push(file)
-      }
-    }
-  } else {
-    // Fallback: use test titles with grep
-    const testTitles = failedTestsData.tests.map(test => test.title).filter(Boolean)
-    if (testTitles.length > 0) {
-      // Create a regex pattern to match any of the failed test titles
-      const grepPattern = testTitles.map(title => title.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')).join('|')
-      options.grep = grepPattern
-    }
-  }
-
-  // Check if user wants to run with workers
-  if (options.workers) {
-    await runWithWorkers(config, options, testPatterns, failedTestsData)
-  } else {
-    await runWithoutWorkers(config, options, testPatterns, failedTestsData, testRoot)
-  }
-}
-
-async function runWithWorkers(config, options, testPatterns, failedTestsData) {
-  const numberOfWorkers = parseInt(options.workers, 10)
-  const overrideConfigs = tryOrDefault(() => JSON.parse(options.override || '{}'), {})
-  
-  // Determine test split strategy
-  let by = 'test' // default for failed tests
-  if (options.by) {
-    by = options.by
-  } else if (options.suites) {
-    by = 'suite'
-  }
-
-  // Validate the by option
-  const validStrategies = ['test', 'suite', 'pool']
-  if (!validStrategies.includes(by)) {
-    throw new Error(`Invalid --by strategy: ${by}. Valid options are: ${validStrategies.join(', ')}`)
-  }
-
-  const workerConfig = {
-    by,
-    testConfig: options.config,
-    options,
-    selectedRuns: undefined,
-  }
-
-  output.print(`CodeceptJS v${require('../codecept').version()}`)
-  output.print(`Re-running ${failedTestsData.tests.length} failed tests in ${output.styles.bold(numberOfWorkers)} workers...`)
-  output.print()
-  store.hasWorkers = true
-
-  const workers = new Workers(numberOfWorkers, workerConfig)
-  workers.overrideConfig(overrideConfigs)
-
-  // Set up event listeners for worker output
-  workers.on('test.failed', test => {
-    output.test.failed(test)
-  })
-
-  workers.on('test.passed', test => {
-    output.test.passed(test)
-  })
-
-  workers.on('test.skipped', test => {
-    output.test.skipped(test)
-  })
-
-  workers.on('all.result', result => {
-    workers.printResults()
-  })
-
-  try {
-    if (options.verbose || options.debug) store.debugMode = true
-
-    if (options.verbose) {
-      output.print('\nFailed tests to re-run with workers:')
-      failedTestsData.tests.forEach((test, index) => {
-        output.print(`  ${index + 1}. ${test.fullTitle || test.title} (${test.file || 'unknown file'})`)
-        if (test.error && test.error.message) {
-          output.print(`     Error: ${test.error.message}`)
-        }
-      })
-      output.print('')
-      
-      const { getMachineInfo } = require('./info')
-      await getMachineInfo()
-    }
-
-    await workers.bootstrapAll()
-    await workers.run()
-  } catch (err) {
-    printError(err)
-    process.exitCode = 1
-  } finally {
-    await workers.teardownAll()
-  }
-}
-
-async function runWithoutWorkers(config, options, testPatterns, failedTestsData, testRoot) {
-  const codecept = new Codecept(config, options)
-
-  try {
-    codecept.init(testRoot)
-    await codecept.bootstrap()
-
-    // Load tests - if we have specific patterns, use them, otherwise load all and filter with grep
-    if (testPatterns.length > 0) {
-      codecept.loadTests(testPatterns.join(' '))
-    } else {
-      codecept.loadTests()
-    }
-
-    if (options.verbose) {
-      global.debugMode = true
-      const { getMachineInfo } = require('./info')
-      await getMachineInfo()
-    }
-
-    // Display information about what we're running
-    if (options.verbose) {
-      output.print('\nFailed tests to re-run:')
-      failedTestsData.tests.forEach((test, index) => {
-        output.print(`  ${index + 1}. ${test.fullTitle || test.title} (${test.file || 'unknown file'})`)
-        if (test.error && test.error.message) {
-          output.print(`     Error: ${test.error.message}`)
-        }
-      })
-      output.print('')
-    }
-
-    await codecept.run()
-  } catch (err) {
-    printError(err)
-    process.exitCode = 1
-  } finally {
-    await codecept.teardown()
-  }
-}