Fix infinite retry on failed assertions (#342)

Author: daniele-pini

cypress/integration/calculator.spec.js

@@ -69,4 +69,16 @@ describe('It should validate cypress react selector', () => {
       expect(value).to.equal(true); // this should ultimately succeed at the 5th retry
     });
   });
+
+  it('getReact should time out after failing assertions', () => {
+    cy.on('fail', (err) => {
+      if (err.message !== 'Timed out retrying after 1000ms: expected false to equal true') {
+        throw err;
+      }
+    });
+
+    cy.getReact('t', { options: { timeout: 1000 } }).should(() => {
+      expect(false).to.equal(true);
+    });
+  });
 });

src/reactHandler.js

@@ -114,33 +114,37 @@ exports.react = (subject, component, reactOpts = {}) => {
   };
 
   const resolveValue = () => {
+    const retry = () => {
+      if (retries < 1) {
+        cy.log(
+          getComponentNotFoundMessage(
+            component,
+            reactOpts.props,
+            reactOpts.state
+          )
+        );
+        return;
+      }
+
+      return cy
+        .wait(retryInterval, {
+          log: false,
+        })
+        .then(() => {
+          retries--;
+          return resolveValue();
+        });
+    };
+
     return _nodes().then((value) => {
       if (!value) {
-        if (retries < 1) {
-          cy.log(
-            getComponentNotFoundMessage(
-              component,
-              reactOpts.props,
-              reactOpts.state
-            )
-          );
-          return;
-        }
-
-        return cy
-          .wait(retryInterval, {
-            log: false,
-          })
-          .then(() => {
-            retries--;
-            return resolveValue();
-          });
+        return retry();
       }
       if (!isPrimitive(value)) {
         value = Cypress.$(value);
       }
       return cy.verifyUpcomingAssertions(value, (reactOpts || {}).options, {
-        onRetry: resolveValue,
+        onRetry: retry,
       });
     });
   };
@@ -243,30 +247,35 @@ exports.getReact = (subject, component, reactOpts = {}) => {
       }
     );
   };
+
   const resolveValue = () => {
+    const retry = () => {
+      if (retries < 1) {
+        cy.log(
+          getComponentNotFoundMessage(
+            component,
+            reactOpts.props,
+            reactOpts.state
+          )
+        );
+        return;
+      }
+      return cy
+        .wait(retryInterval, {
+          log: false,
+        })
+        .then(() => {
+          retries--;
+          return resolveValue();
+        });
+    };
+
     return _nodes().then((value) => {
       if (!value) {
-        if (retries < 1) {
-          cy.log(
-            getComponentNotFoundMessage(
-              component,
-              reactOpts.props,
-              reactOpts.state
-            )
-          );
-          return;
-        }
-        return cy
-          .wait(retryInterval, {
-            log: false,
-          })
-          .then(() => {
-            retries--;
-            return resolveValue();
-          });
+        return retry();
       }
       return cy.verifyUpcomingAssertions(value, (reactOpts || {}).options, {
-        onRetry: resolveValue,
+        onRetry: retry,
       });
     });
   };