fixed tryTo/retryTo regressions

Author: DavertMik

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

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`)

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,
 }

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

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

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,13 @@ 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
+    if (test.opts.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)
   })
 }

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)

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,

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.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.7.0-beta.14",
+  "version": "3.7.0-beta.15",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",