codeceptjs 3.7.0-beta.15 → 3.7.0-beta.17

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`)
@@ -142,6 +142,7 @@ module.exports = async function (options) {
       }
       checks.setup = true
     } catch (err) {
+      err.message = `${helper.constructor.name} helper failed: ${err.message}`
       checks.setup = err
     }
   }

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/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.15",
+  "version": "3.7.0-beta.17",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",

package/typings/promiseBasedTypes.d.ts

@@ -1759,6 +1759,10 @@ declare namespace CodeceptJS {
      * @property [host = "0.0.0.0"] - Mock server host
      * @property [httpsOpts] - key & cert values are the paths to .key and .crt files
      */
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type MockServerConfig = {
         port?: number;
         host?: string;
@@ -1883,6 +1887,10 @@ declare namespace CodeceptJS {
      *
      * ## Methods
      */
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     class MockServer {
         /**
          * Start the mock server
@@ -2916,6 +2924,10 @@ declare namespace CodeceptJS {
      * @property [recordHar] - record HAR and will be saved to `output/har`. See more of [HAR options](https://playwright.dev/docs/api/class-browser#browser-new-context-option-record-har).
      * @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).
      */
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type PlaywrightConfig = {
         url?: string;
         browser?: 'chromium' | 'firefox' | 'webkit' | 'electron';
@@ -6292,6 +6304,10 @@ 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
+    // @ts-ignore
     type PuppeteerConfig = {
         url: string;
         basicAuth?: any;
@@ -8098,6 +8114,10 @@ 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
+    // @ts-ignore
     type RESTConfig = {
         endpoint?: string;
         prettyPrintJson?: boolean;
@@ -9242,6 +9262,10 @@ 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
+    // @ts-ignore
     type WebDriverConfig = {
         url: string;
         browser: string;

package/typings/types.d.ts

@@ -1786,6 +1786,10 @@ declare namespace CodeceptJS {
      * @property [host = "0.0.0.0"] - Mock server host
      * @property [httpsOpts] - key & cert values are the paths to .key and .crt files
      */
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type MockServerConfig = {
         port?: number;
         host?: string;
@@ -1910,6 +1914,10 @@ declare namespace CodeceptJS {
      *
      * ## Methods
      */
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     class MockServer {
         /**
          * Start the mock server
@@ -3009,6 +3017,10 @@ declare namespace CodeceptJS {
      * @property [recordHar] - record HAR and will be saved to `output/har`. See more of [HAR options](https://playwright.dev/docs/api/class-browser#browser-new-context-option-record-har).
      * @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).
      */
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
+    // @ts-ignore
     type PlaywrightConfig = {
         url?: string;
         browser?: 'chromium' | 'firefox' | 'webkit' | 'electron';
@@ -6536,6 +6548,10 @@ 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
+    // @ts-ignore
     type PuppeteerConfig = {
         url: string;
         basicAuth?: any;
@@ -8478,6 +8494,10 @@ 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
+    // @ts-ignore
     type RESTConfig = {
         endpoint?: string;
         prettyPrintJson?: boolean;
@@ -9682,6 +9702,10 @@ 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
+    // @ts-ignore
     type WebDriverConfig = {
         url: string;
         browser: string;
@@ -12209,12 +12233,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;
     }
     /**
@@ -12355,6 +12396,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.