From f93380b98fb3135ceaacc3c0ce1ad125cc8b384e Mon Sep 17 00:00:00 2001
From: Nicholas Boll <nicholas.boll@workday.com>
Date: Wed, 4 Mar 2020 22:59:54 -0700
Subject: [PATCH 1/4] fix: Revert to previous query* API Fixes #117

---
 cypress/integration/query.spec.js | 20 ++++++++++++++++----
 src/index.js                      |  9 ++++++++-
 2 files changed, 24 insertions(+), 5 deletions(-)

diff --git a/cypress/integration/query.spec.js b/cypress/integration/query.spec.js
index 3ef0905..d7152f2 100644
--- a/cypress/integration/query.spec.js
+++ b/cypress/integration/query.spec.js
@@ -85,6 +85,18 @@ describe('query* dom-testing-library commands', () => {
 
   /* Test the behaviour around these queries */
 
+  it('should handle previous ways of querying non-existence', () => {
+    cy.queryByText('Eventually not exists').then($el => {
+      cy.wrap($el).should('not.exist')
+    })
+  })
+
+  it('should handle previous ways of querying eventual non-existence', () => {
+    cy.queryByText(`Currently does not exist`).then($el => {
+      cy.wrap($el).should('not.exist')
+    })
+  })
+
   it('queryByText with .should(\'not.exist\')', () => {
     cy.queryAllByText(/^Button Text \d$/).should('exist')
     cy.queryByText('Non-existing Button Text', {timeout: 100}).should('not.exist')
@@ -117,7 +129,7 @@ describe('query* dom-testing-library commands', () => {
   it('query* will return immediately, and never retry', () => {
     cy.queryByText('Next Page').click()
 
-    const errorMessage = `Unable to find an element with the text: New Page Loaded.`
+    const errorMessage = "'queryByText(`New Page Loaded`)' to exist in the DOM"
     cy.on('fail', err => {
       expect(err.message).to.contain(errorMessage)
     })
@@ -150,7 +162,7 @@ describe('query* dom-testing-library commands', () => {
 
   it('queryAllByText should forward existence error message from @testing-library/dom', () => {
     const text = 'Supercalifragilistic'
-    const errorMessage = `Unable to find an element with the text: Supercalifragilistic.`
+    const errorMessage = "'queryAllByText(`Supercalifragilistic`)' to exist in the DOM"
     cy.on('fail', err => {
       expect(err.message).to.contain(errorMessage)
     })
@@ -159,7 +171,7 @@ describe('query* dom-testing-library commands', () => {
   })
 
   it('queryByLabelText should forward useful error messages from @testing-library/dom', () => {
-    const errorMessage = `Found a label with the text of: Label 3, however no form control was found associated to that label.`
+    const errorMessage = "'queryByLabelText(`Label 3`)' to exist in the DOM"
     cy.on('fail', err => {
       expect(err.message).to.contain(errorMessage)
     })
@@ -168,7 +180,7 @@ describe('query* dom-testing-library commands', () => {
   })
 
   it('queryAllByText should default to Cypress non-existence error message', () => {
-    const errorMessage = `Expected <button> not to exist in the DOM, but it was continuously found.`
+    const errorMessage = `expected '<button>' not to exist in the DOM`
     cy.on('fail', err => {
       expect(err.message).to.contain(errorMessage)
     })
diff --git a/src/index.js b/src/index.js
index 26740ed..af14cfc 100644
--- a/src/index.js
+++ b/src/index.js
@@ -34,7 +34,7 @@ const getCommands = getQueryNames.map(queryName => {
 })
 
 const queryCommands = queryQueryNames.map(queryName => {
-  return createCommand(queryName, queryName.replace(queryRegex, 'get'))
+  return createCommand(queryName, queryName)
 })
 
 const findCommands = findQueryNames.map(queryName => {
@@ -162,6 +162,13 @@ function createCommand(queryName, implementationName) {
         })
       }
 
+      if (queryRegex.test(queryName)) {
+        const value = getValue()
+        options._log.snapshot().error(Error(`@testing-library/cypress is deprecating all 'query*' commands. 'find*' queries support non-existence starting with version 5 (E.g. cy.findByText('Does Not Exist').should('not.exist')). Please use cy.${queryName.replace(queryRegex, 'find')}(${queryArgument(args)}) instead.`))
+
+        return value
+      }
+
       return resolveValue().then(subject => {
         // Remove the error that occurred because it is irrelevant now
         if (consoleProps.error) {

From a3f813594b7e2adb774a7cc537f0f2605528c1cd Mon Sep 17 00:00:00 2001
From: Nicholas Boll <nicholas.boll@workday.com>
Date: Thu, 5 Mar 2020 13:12:22 -0700
Subject: [PATCH 2/4] chore: add deprecation warning to query*

---
 cypress/integration/query.spec.js | 28 +++++++++++++++-------------
 src/index.js                      | 13 ++++---------
 2 files changed, 19 insertions(+), 22 deletions(-)

diff --git a/cypress/integration/query.spec.js b/cypress/integration/query.spec.js
index d7152f2..767255d 100644
--- a/cypress/integration/query.spec.js
+++ b/cypress/integration/query.spec.js
@@ -85,16 +85,18 @@ describe('query* dom-testing-library commands', () => {
 
   /* Test the behaviour around these queries */
 
-  it('should handle previous ways of querying non-existence', () => {
-    cy.queryByText('Eventually not exists').then($el => {
-      cy.wrap($el).should('not.exist')
-    })
-  })
-
-  it('should handle previous ways of querying eventual non-existence', () => {
-    cy.queryByText(`Currently does not exist`).then($el => {
-      cy.wrap($el).should('not.exist')
+  it('queryByText should show a deprecation warning', () => {
+    let addedLog
+    cy.on('log:added', (_, log) => {
+      addedLog = log
     })
+    cy.queryByText('Button Text 1')
+      .then(() => {
+        const attrs = addedLog.toJSON()
+        expect(attrs).to.have.property('state', 'failed')
+        expect(attrs).to.have.deep.property('err.message')
+        expect(attrs.err.message).to.contain(`@testing-library/cypress is deprecating all 'query*' commands.`)
+      })
   })
 
   it('queryByText with .should(\'not.exist\')', () => {
@@ -129,7 +131,7 @@ describe('query* dom-testing-library commands', () => {
   it('query* will return immediately, and never retry', () => {
     cy.queryByText('Next Page').click()
 
-    const errorMessage = "'queryByText(`New Page Loaded`)' to exist in the DOM"
+    const errorMessage = `Unable to find an element with the text: New Page Loaded.`
     cy.on('fail', err => {
       expect(err.message).to.contain(errorMessage)
     })
@@ -162,7 +164,7 @@ describe('query* dom-testing-library commands', () => {
 
   it('queryAllByText should forward existence error message from @testing-library/dom', () => {
     const text = 'Supercalifragilistic'
-    const errorMessage = "'queryAllByText(`Supercalifragilistic`)' to exist in the DOM"
+    const errorMessage = `Unable to find an element with the text: Supercalifragilistic.`
     cy.on('fail', err => {
       expect(err.message).to.contain(errorMessage)
     })
@@ -171,7 +173,7 @@ describe('query* dom-testing-library commands', () => {
   })
 
   it('queryByLabelText should forward useful error messages from @testing-library/dom', () => {
-    const errorMessage = "'queryByLabelText(`Label 3`)' to exist in the DOM"
+    const errorMessage = `Found a label with the text of: Label 3, however no form control was found associated to that label.`
     cy.on('fail', err => {
       expect(err.message).to.contain(errorMessage)
     })
@@ -180,7 +182,7 @@ describe('query* dom-testing-library commands', () => {
   })
 
   it('queryAllByText should default to Cypress non-existence error message', () => {
-    const errorMessage = `expected '<button>' not to exist in the DOM`
+    const errorMessage = `Expected <button> not to exist in the DOM, but it was continuously found.`
     cy.on('fail', err => {
       expect(err.message).to.contain(errorMessage)
     })
diff --git a/src/index.js b/src/index.js
index af14cfc..a3eb575 100644
--- a/src/index.js
+++ b/src/index.js
@@ -34,7 +34,7 @@ const getCommands = getQueryNames.map(queryName => {
 })
 
 const queryCommands = queryQueryNames.map(queryName => {
-  return createCommand(queryName, queryName)
+  return createCommand(queryName, queryName.replace(queryRegex, 'get'))
 })
 
 const findCommands = findQueryNames.map(queryName => {
@@ -162,13 +162,6 @@ function createCommand(queryName, implementationName) {
         })
       }
 
-      if (queryRegex.test(queryName)) {
-        const value = getValue()
-        options._log.snapshot().error(Error(`@testing-library/cypress is deprecating all 'query*' commands. 'find*' queries support non-existence starting with version 5 (E.g. cy.findByText('Does Not Exist').should('not.exist')). Please use cy.${queryName.replace(queryRegex, 'find')}(${queryArgument(args)}) instead.`))
-
-        return value
-      }
-
       return resolveValue().then(subject => {
         // Remove the error that occurred because it is irrelevant now
         if (consoleProps.error) {
@@ -181,7 +174,9 @@ function createCommand(queryName, implementationName) {
         return subject
       }).finally(() => {
         if (options._log) {
-          if (failedNewFunctionality && !failedOldFunctionality) {
+          if (queryRegex.test(queryName)) {
+            options._log.error(Error(`@testing-library/cypress is deprecating all 'query*' commands. 'find*' queries support non-existence starting with version 5 (E.g. cy.findByText('Does Not Exist').should('not.exist')). Please use cy.${queryName.replace(queryRegex, 'find')}(${queryArgument(args)}) instead.`))
+          } else if (failedNewFunctionality && !failedOldFunctionality) {
             options._log.error(Error(`@testing-library/cypress will eventually only use previous subjects when queries are added to a chain of commands. We've detected an instance where the this functionality failed, but the old functionality passed (so your test may break in a future version). Please use cy.${queryName}(${queryArgument(args)}) instead of continuing from a previous chain.`))
           } else {
             options._log.end()

From f942acc4ed9dd35dd54508374105915bbf397ec3 Mon Sep 17 00:00:00 2001
From: Nicholas Boll <nicholas.boll@workday.com>
Date: Wed, 11 Mar 2020 09:05:06 -0600
Subject: [PATCH 3/4] test: fix timing of the deprecation test for query*

---
 cypress/integration/query.spec.js | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

diff --git a/cypress/integration/query.spec.js b/cypress/integration/query.spec.js
index 767255d..a62ae17 100644
--- a/cypress/integration/query.spec.js
+++ b/cypress/integration/query.spec.js
@@ -87,11 +87,16 @@ describe('query* dom-testing-library commands', () => {
 
   it('queryByText should show a deprecation warning', () => {
     let addedLog
-    cy.on('log:added', (_, log) => {
+    function addLog (_, log) {
       addedLog = log
-    })
+      cy.off('log:added', addLog)
+    }
+    cy.on('log:added', addLog)
+
     cy.queryByText('Button Text 1')
-      .then(() => {
+      // query* doesn't retry more than once, but our log could be updated later depending on timing.
+      // the `cy.wrap` adds a retryable step in to deal with possible timing issues of the assertions.
+      cy.wrap(null).should(() => {
         const attrs = addedLog.toJSON()
         expect(attrs).to.have.property('state', 'failed')
         expect(attrs).to.have.deep.property('err.message')

From a6f97935cb26e666ffacfca193dbb91ceb7c2363 Mon Sep 17 00:00:00 2001
From: Nicholas Boll <nicholas.boll@workday.com>
Date: Wed, 11 Mar 2020 23:07:26 -0600
Subject: [PATCH 4/4] test: fix timing of the deprecation test for query*

---
 cypress/integration/query.spec.js | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/cypress/integration/query.spec.js b/cypress/integration/query.spec.js
index a62ae17..24671d3 100644
--- a/cypress/integration/query.spec.js
+++ b/cypress/integration/query.spec.js
@@ -99,7 +99,7 @@ describe('query* dom-testing-library commands', () => {
       cy.wrap(null).should(() => {
         const attrs = addedLog.toJSON()
         expect(attrs).to.have.property('state', 'failed')
-        expect(attrs).to.have.deep.property('err.message')
+        expect(attrs).to.have.nested.property('err.message')
         expect(attrs.err.message).to.contain(`@testing-library/cypress is deprecating all 'query*' commands.`)
       })
   })