codeceptjs 4.2.0 → 4.2.1-beta.1

package/lib/effects.js

@@ -7,6 +7,16 @@ import MetaStep from './step/meta.js'
 import { empty } from './assert/empty.js'
 import { isAsyncFunction } from './utils.js'
 
+let activeEffects = 0
+
+/**
+ * Returns true while steps are executed inside tryTo or a retryTo attempt that will be retried
+ * @return {boolean}
+ */
+function isEffectActive() {
+  return activeEffects > 0
+}
+
 /**
  * @param {CodeceptJS.LocatorOrString}  context
  * @param {Function}  fn
@@ -117,6 +127,7 @@ class WithinStep extends MetaStep {
 let hopeThatFailures = []
 event.dispatcher.on(event.test.before, () => {
   hopeThatFailures = []
+  activeEffects = 0
 })
 
 async function hopeThat(callback) {
@@ -214,6 +225,8 @@ async function retryTo(callback, maxTries, pollInterval = 200) {
 
     const tryBlock = async () => {
       tries++
+      const willRetry = tries < maxTries
+      if (willRetry) activeEffects++
       recorder.session.start(`${sessionName} ${tries}`)
       try {
         await callback(tries)
@@ -223,12 +236,14 @@ async function retryTo(callback, maxTries, pollInterval = 200) {
 
       // Call done if no errors
       recorder.add(() => {
+        if (willRetry) activeEffects--
         recorder.session.restore(`${sessionName} ${tries}`)
         done(null)
       })
 
       // Catch errors and retry
       recorder.session.catch(err => {
+        if (willRetry) activeEffects--
         recorder.session.restore(`${sessionName} ${tries}`)
         if (tries < maxTries) {
           output.debug(`Error ${err}... Retrying`)
@@ -288,6 +303,7 @@ async function tryTo(callback) {
       isAutoRetriesEnabled = store.autoRetries
       if (isAutoRetriesEnabled) output.debug('Auto retries disabled inside tryTo effect')
       store.autoRetries = false
+      activeEffects++
       callback()
       recorder.add(() => {
         result = true
@@ -305,6 +321,7 @@ async function tryTo(callback) {
         'result',
         () => {
           store.autoRetries = isAutoRetriesEnabled
+          activeEffects--
           return result
         },
         true,
@@ -316,11 +333,12 @@ async function tryTo(callback) {
   )
 }
 
-export { hopeThat, retryTo, tryTo, within }
+export { hopeThat, retryTo, tryTo, within, isEffectActive }
 
 export default {
   hopeThat,
   retryTo,
   tryTo,
   within,
+  isEffectActive,
 }