codeceptjs 3.7.0-beta.14 → 3.7.0-beta.16

package/bin/codecept.js

@@ -62,7 +62,7 @@ program
   .command('check')
   .option(commandFlags.config.flag, commandFlags.config.description)
   .description('Checks configuration and environment before running tests')
-  .option('-t, --timeout [ms]', 'timeout for checks in ms, 20000 by default')
+  .option('-t, --timeout [ms]', 'timeout for checks in ms, 50000 by default')
   .action(errorHandler(require('../lib/command/check')))
 
 program

package/lib/command/check.js

@@ -87,9 +87,9 @@ module.exports = async function (options) {
 
   if (config?.ai?.request) {
     checks.ai = true
-    printCheck('ai', checks['ai'], 'AI configuration is enabled, request function is set')
+    printCheck('ai', checks['ai'], 'Configuration is enabled, request function is set')
   } else {
-    printCheck('ai', checks['ai'], 'AI is disabled')
+    printCheck('ai', checks['ai'], 'Disabled')
   }
 
   printCheck('tests', checks['tests'], `Total: ${numTests} tests`)

package/lib/effects.js

@@ -2,6 +2,7 @@ const recorder = require('./recorder')
 const { debug } = require('./output')
 const store = require('./store')
 const event = require('./event')
+const within = require('./within')
 
 /**
  * A utility function for CodeceptJS tests that acts as a soft assertion.
@@ -178,11 +179,14 @@ async function tryTo(callback) {
   const sessionName = 'tryTo'
 
   let result = false
+  let hasAutoRetriesEnabled = store.autoRetries
   return recorder.add(
     sessionName,
     () => {
       recorder.session.start(sessionName)
-      store.tryTo = true
+      hasAutoRetriesEnabled = store.autoRetries
+      if (hasAutoRetriesEnabled) debug('Auto retries disabled inside tryTo effect')
+      store.autoRetries = false
       callback()
       recorder.add(() => {
         result = true
@@ -199,7 +203,7 @@ async function tryTo(callback) {
       return recorder.add(
         'result',
         () => {
-          store.tryTo = undefined
+          store.autoRetries = hasAutoRetriesEnabled
           return result
         },
         true,
@@ -215,4 +219,5 @@ module.exports = {
   hopeThat,
   retryTo,
   tryTo,
+  within,
 }

package/lib/helper/Playwright.js

@@ -484,7 +484,7 @@ class Playwright extends Helper {
     this.currentRunningTest = test
 
     recorder.retry({
-      retries: process.env.FAILED_STEP_RETRIES || 3,
+      retries: test.opts?.conditionalRetries || 3,
       when: err => {
         if (!err || typeof err.message !== 'string') {
           return false

package/lib/helper/Puppeteer.js

@@ -312,7 +312,7 @@ class Puppeteer extends Helper {
     this.sessionPages = {}
     this.currentRunningTest = test
     recorder.retry({
-      retries: process.env.FAILED_STEP_RETRIES || 3,
+      retries: test.opts?.conditionalRetries || 3,
       when: err => {
         if (!err || typeof err.message !== 'string') {
           return false

package/lib/plugin/retryFailedStep.js

@@ -1,8 +1,6 @@
 const event = require('../event')
 const recorder = require('../recorder')
-const container = require('../container')
-const { log } = require('../output')
-
+const store = require('../store')
 const defaultConfig = {
   retries: 3,
   defaultIgnoredSteps: ['amOnPage', 'wait*', 'send*', 'execute*', 'run*', 'have*'],
@@ -70,9 +68,9 @@ const defaultConfig = {
  * Use scenario configuration to disable plugin for a test
  *
  * ```js
- * Scenario('scenario tite', () => {
+ * Scenario('scenario tite', { disableRetryFailedStep: true }, () => {
  *    // test goes here
- * }).config(test => test.disableRetryFailedStep = true)
+ * })
  * ```
  *
  */
@@ -85,19 +83,14 @@ module.exports = config => {
 
   const when = err => {
     if (!enableRetry) return
-    const store = require('../store')
     if (store.debugMode) return false
+    if (!store.autoRetries) return false
     if (customWhen) return customWhen(err)
     return true
   }
   config.when = when
 
   event.dispatcher.on(event.step.started, step => {
-    if (process.env.TRY_TO === 'true') {
-      log('Info: RetryFailedStep plugin is disabled inside tryTo block')
-      return
-    }
-
     // if a step is ignored - return
     for (const ignored of config.ignoredSteps) {
       if (step.name === ignored) return
@@ -113,9 +106,15 @@ module.exports = config => {
   })
 
   event.dispatcher.on(event.test.before, test => {
-    if (test && test.disableRetryFailedStep) return // disable retry when a test is not active
-    // this env var is used to set the retries inside _before() block of helpers
-    process.env.FAILED_STEP_RETRIES = config.retries
+    // pass disableRetryFailedStep is a preferred way to disable retries
+    // test.disableRetryFailedStep is used for backward compatibility
+    if (test.opts.disableRetryFailedStep || test.disableRetryFailedStep) {
+      store.autoRetries = false
+      return // disable retry when a test is not active
+    }
+    // this option is used to set the retries inside _before() block of helpers
+    store.autoRetries = true
+    test.opts.conditionalRetries = config.retries
     recorder.retry(config)
   })
 }

package/lib/recorder.js

@@ -192,6 +192,7 @@ module.exports = {
         .pop()
       // no retries or unnamed tasks
       debug(`${currentQueue()} Running | ${taskName} | Timeout: ${timeout || 'None'}`)
+      if (retryOpts) debug(`${currentQueue()} Retry opts`, JSON.stringify(retryOpts))
 
       if (!retryOpts || !taskName || !retry) {
         const [promise, timer] = getTimeoutPromise(timeout, taskName)

package/lib/step/base.js

@@ -25,8 +25,7 @@ class Step {
     this.opts = {}
     /** @member {string} */
     this.actor = 'I' // I = actor
-    /** @member {string} */
-    this.helperMethod = name // helper method
+
     /** @member {string} */
     this.status = 'pending'
     /** @member {string} */
@@ -38,6 +37,13 @@ class Step {
     /** @member {string} */
     this.stack = ''
 
+    // These are part of HelperStep class
+    // but left here for types compatibility
+    /** @member {any} */
+    this.helper = null
+    /** @member {string} */
+    this.helperMethod = name
+
     this.startTime = 0
     this.endTime = 0
 

package/lib/store.js

@@ -3,17 +3,41 @@
  * @namespace
  */
 const store = {
-  /** @type {boolean} */
+  /**
+   * If we are in --debug mode
+   * @type {boolean}
+   */
   debugMode: false,
-  /** @type {boolean} */
+
+  /**
+   * Is timeouts enabled
+   * @type {boolean}
+   */
   timeouts: true,
-  /** @type {boolean} */
+
+  /**
+   * If auto-retries are enabled by retryFailedStep plugin
+   * tryTo effect disables them
+   * @type {boolean}
+   */
+  autoRetries: false,
+
+  /**
+   * Tests are executed via dry-run
+   * @type {boolean}
+   */
   dryRun: false,
-  /** @type {boolean} */
+  /**
+   * If we are in pause mode
+   * @type {boolean}
+   */
   onPause: false,
+
+  // current object states
+
   /** @type {CodeceptJS.Test | null} */
   currentTest: null,
-  /** @type {any} */
+  /** @type {CodeceptJS.Step | null} */
   currentStep: null,
   /** @type {CodeceptJS.Suite | null} */
   currentSuite: null,

package/lib/within.js

@@ -7,6 +7,8 @@ const MetaStep = require('./step/meta')
 const { isAsyncFunction } = require('./utils')
 
 /**
+ * TODO: move to effects
+ *
  * @param {CodeceptJS.LocatorOrString}  context
  * @param {Function}  fn
  * @return {Promise<*> | undefined}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.7.0-beta.14",
+  "version": "3.7.0-beta.16",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -31,6 +31,7 @@
   "main": "lib/index.js",
   "exports": {
     ".": "./lib/index.js",
+    "./lib/*": "./lib/*.js",
     "./els": "./lib/els.js",
     "./effects": "./lib/effects.js",
     "./steps": "./lib/steps.js"
@@ -77,8 +78,8 @@
     "@codeceptjs/configure": "1.0.2",
     "@codeceptjs/helper": "2.0.4",
     "@cucumber/cucumber-expressions": "18",
-    "@cucumber/gherkin": "30",
-    "@cucumber/messages": "27.1.0",
+    "@cucumber/gherkin": "31",
+    "@cucumber/messages": "27.2.0",
     "@xmldom/xmldom": "0.9.7",
     "acorn": "8.14.0",
     "arrify": "3.0.0",
@@ -129,16 +130,16 @@
     "@pollyjs/core": "5.1.0",
     "@types/chai": "4.3.19",
     "@types/inquirer": "9.0.7",
-    "@types/node": "22.12.0",
-    "@wdio/sauce-service": "9.7.1",
+    "@types/node": "22.13.0",
+    "@wdio/sauce-service": "9.7.2",
     "@wdio/selenium-standalone-service": "8.15.0",
-    "@wdio/utils": "9.6.4",
+    "@wdio/utils": "9.7.2",
     "@xmldom/xmldom": "0.9.7",
     "chai": "^4.0.0",
     "chai-as-promised": "7.1.2",
     "chai-subset": "1.6.0",
     "documentation": "14.0.3",
-    "electron": "34.0.1",
+    "electron": "34.0.2",
     "eslint": "^9.19.0",
     "eslint-plugin-import": "2.31.0",
     "eslint-plugin-mocha": "10.5.0",
@@ -152,13 +153,13 @@
     "jsdoc": "^3.6.11",
     "jsdoc-typeof-plugin": "1.0.0",
     "json-server": "0.17.4",
-    "playwright": "1.50.0",
+    "playwright": "1.50.1",
     "prettier": "^3.3.2",
     "puppeteer": "24.1.1",
     "qrcode-terminal": "0.12.0",
     "rosie": "2.1.1",
     "runok": "0.9.3",
-    "semver": "7.6.3",
+    "semver": "7.7.0",
     "sinon": "19.0.2",
     "sinon-chai": "3.7.0",
     "testcafe": "3.7.1",
@@ -169,8 +170,8 @@
     "typedoc": "0.27.6",
     "typedoc-plugin-markdown": "4.4.1",
     "typescript": "5.7.3",
-    "wdio-docker-service": "1.5.0",
-    "webdriverio": "^9.7.1",
+    "wdio-docker-service": "3.2.1",
+    "webdriverio": "9.7.2",
     "xml2js": "0.6.2",
     "xpath": "0.0.34"
   },

package/typings/promiseBasedTypes.d.ts

@@ -1762,7 +1762,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
     type MockServerConfig = {
         port?: number;
         host?: string;
@@ -1890,7 +1889,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
     class MockServer {
         /**
          * Start the mock server
@@ -2927,7 +2925,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
     type PlaywrightConfig = {
         url?: string;
         browser?: 'chromium' | 'firefox' | 'webkit' | 'electron';
@@ -6307,7 +6304,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
     type PuppeteerConfig = {
         url: string;
         basicAuth?: any;
@@ -8117,7 +8113,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
     type RESTConfig = {
         endpoint?: string;
         prettyPrintJson?: boolean;
@@ -9265,7 +9260,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
     type WebDriverConfig = {
         url: string;
         browser: string;

package/typings/types.d.ts

@@ -1789,7 +1789,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
     type MockServerConfig = {
         port?: number;
         host?: string;
@@ -1917,7 +1916,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
     class MockServer {
         /**
          * Start the mock server
@@ -3020,7 +3018,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
     type PlaywrightConfig = {
         url?: string;
         browser?: 'chromium' | 'firefox' | 'webkit' | 'electron';
@@ -6551,7 +6548,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
     type PuppeteerConfig = {
         url: string;
         basicAuth?: any;
@@ -8497,7 +8493,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
     type RESTConfig = {
         endpoint?: string;
         prettyPrintJson?: boolean;
@@ -9705,7 +9700,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
     type WebDriverConfig = {
         url: string;
         browser: string;
@@ -11787,6 +11781,10 @@ declare namespace CodeceptJS {
      * Dependency Injection Container
      */
     class Container {
+        /**
+         * Get the standard acting helpers of CodeceptJS Container
+         */
+        static STANDARD_ACTING_HELPERS: any;
         /**
          * Create container with all required helpers and support objects
          */
@@ -11831,16 +11829,12 @@ declare namespace CodeceptJS {
         }, newPlugins: {
             [key: string]: any;
         }): void;
-        static started(fn: (...params: any[]) => any): Promise<void>;
+        static started(fn: ((...params: any[]) => any) | null): Promise<void>;
         /**
          * Share data across worker threads
          * @param options - set {local: true} to not share among workers
          */
         static share(data: any, options: any): void;
-        /**
-         * List of helpers that are used in CodeceptJS and can't be used together
-         */
-        static STANDARD_ACTING_HELPERS: string[];
     }
     /**
      * Method collect own property and prototype
@@ -12204,12 +12198,13 @@ declare namespace CodeceptJS {
         args: any[];
         opts: Record<string, any>;
         actor: string;
-        helperMethod: string;
         status: string;
         prefix: string;
         comment: string;
         metaStep: any;
         stack: string;
+        helper: any;
+        helperMethod: string;
         timeout: any;
         /**
          * @param timeout - timeout in milliseconds or 0 if no timeout
@@ -12232,12 +12227,29 @@ declare namespace CodeceptJS {
      * global values for current session
      */
     namespace store {
+        /**
+         * If we are in --debug mode
+         */
         var debugMode: boolean;
+        /**
+         * Is timeouts enabled
+         */
         var timeouts: boolean;
+        /**
+         * If auto-retries are enabled by retryFailedStep plugin
+         * tryTo effect disables them
+         */
+        var autoRetries: boolean;
+        /**
+         * Tests are executed via dry-run
+         */
         var dryRun: boolean;
+        /**
+         * If we are in pause mode
+         */
         var onPause: boolean;
         var currentTest: CodeceptJS.Test | null;
-        var currentStep: any;
+        var currentStep: CodeceptJS.Step | null;
         var currentSuite: CodeceptJS.Suite | null;
     }
     /**
@@ -12378,6 +12390,9 @@ declare namespace CodeceptJS {
         */
         err: Error | null;
     }
+    /**
+     * TODO: move to effects
+     */
     function within(context: CodeceptJS.LocatorOrString, fn: (...params: any[]) => any): Promise<any> | undefined;
     /**
      * This is a wrapper on top of [Detox](https://github.com/wix/Detox) library, aimied to unify testing experience for CodeceptJS framework.