feat: add retries, close #3

README.md

@@ -32,7 +32,7 @@ See [cypress/integration/spec.js](cypress/integration/spec.js)
 ## Roadmap
 
 - [x] wrap returned DOM nodes in jQuery [#2](https://github.com/cypress-io/cypress-xpath/issues/2)
-- [ ] retry the assertion that follows [#3](https://github.com/cypress-io/cypress-xpath/issues/3)
+- [x] retry the assertion that follows [#3](https://github.com/cypress-io/cypress-xpath/issues/3)
 - [ ] add TypeScript definitions [#4](https://github.com/cypress-io/cypress-xpath/issues/4)
 - [ ] search from the previous subject element [#5](https://github.com/cypress-io/cypress-xpath/issues/5)
 

cypress/integration/spec.js

@@ -24,7 +24,7 @@ describe('cypress-xpath', () => {
       cy.xpath('//h1/text()').its('0.textContent').should('equal', 'cypress-xpath')
     })
 
-    it.skip('retries until element is inserted', () => {
+    it('retries until element is inserted', () => {
       // the element will be inserted after 1 second
       cy.xpath('string(//*[@id="inserted"])').should('equal', 'inserted text')
     })

src/index.js

@@ -13,7 +13,7 @@
   })
  ```
  */
-const xpath = (selector) => {
+const xpath = (selector, options = {}) => {
   /* global XPathResult */
   const isNumber = (xpathResult) => xpathResult.resultType === XPathResult.NUMBER_TYPE
   const numberResult = (xpathResult) => xpathResult.numberValue
@@ -96,15 +96,24 @@ const xpath = (selector) => {
     }
   }
 
-  const nodes = getValue()
+  const resolveValue = () => {
+    return Cypress.Promise.try(getValue).then(value => {
+      return cy.verifyUpcomingAssertions(value, options, {
+        onRetry: resolveValue,
+      })
+    })
+  }
+
+  return resolveValue().then((value) => {
+    // TODO set found elements on the command log?
+    Cypress.log(log)
+    if (isPrimitive(value)) {
+      return value
+    }
+    return Cypress.$(value)
+  })
 
-  // TODO set found elements on the command log?
-  Cypress.log(log)
 
-  if (isPrimitive(nodes)) {
-    return nodes
-  }
-  return Cypress.$(nodes)
 }
 
 Cypress.Commands.add('xpath', xpath)