fix: cy.contains() ignores <style> and <script> without removin…

…g them. (#19424) * fix * Merge tests. * fix * Apply suggestions from code review Co-authored-by: Emily Rohrbough <[email protected]> * kick off build again Co-authored-by: Emily Rohrbough <[email protected]> Co-authored-by: Matt Henkes <[email protected]>
cypress-io · Dec 20, 2021 · 3250945 · 3250945 · cypress-bot · Dec 20, 2021
1 parent 593d4b8
commit 3250945
Show file tree

Hide file tree

Showing 3 changed files with 60 additions and 20 deletions.
diff --git a/packages/driver/cypress/fixtures/content-in-body.html b/packages/driver/cypress/fixtures/content-in-body.html
@@ -17,5 +17,25 @@ <h1>Script and Style in the body</h1>
       h1 { font-size: 32px }
     </style>
   </div>
+
+  <!--
+    // https://github.com/cypress-io/cypress/issues/19377
+    Below is added to ensure `style`, `script` tags are not removed by `cy.contains()` command.
+  -->
+  <p>Hello</p>
+  <button id="my_button_1" style="display: none;">I'm a button</button>
+  <button id="my_button_2">Click me</button>
+  <div id="result"></div>
+  <style>
+      button#my_button_1 {
+          background-color: red;
+          display: inline !important;
+      }
+  </style>
+  <script id="my_script">
+      document.getElementById('my_button_2').addEventListener('click', function() {
+          document.getElementById('result').innerHTML = 'This is the result';
+      });
+  </script>
 </body>
 </html>
diff --git a/packages/driver/cypress/integration/commands/querying_spec.js b/packages/driver/cypress/integration/commands/querying_spec.js
@@ -1955,6 +1955,7 @@ space
       })
     })
 
+    // https://github.com/cypress-io/cypress/issues/14861
     describe('ignores style and script tag in body', () => {
       it('style', (done) => {
         cy.on('fail', (err) => {
@@ -1977,6 +1978,35 @@ space
         cy.visit('fixtures/content-in-body.html')
         cy.contains('I am in the script tag in body', { timeout: 500 })
       })
+
+      // https://github.com/cypress-io/cypress/issues/19377
+      describe('cy.contains() does not remove <style> and <script> tags', () => {
+        it('cy.contains() does not remove style tags from the DOM', () => {
+          cy.visit('fixtures/content-in-body.html')
+
+          cy.get('button#my_button_1').should('be.visible')
+          cy.contains('Hello').should('be.visible')
+          cy.get('button#my_button_1').should('be.visible')
+        })
+
+        it('cy.contains() does not remove script tags from the DOM', () => {
+          cy.visit('fixtures/content-in-body.html')
+
+          cy.window().then((win) => {
+            const scriptElement = win.document.getElementById('my_script')
+
+            expect(scriptElement?.id).to.equal('my_script')
+          })
+
+          cy.get('button#my_button_2').click()
+          cy.contains('This is the result').should('be.visible')
+          cy.window().then((win) => {
+            const scriptElement = win.document.getElementById('my_script')
+
+            expect(scriptElement?.id).to.equal('my_script')
+          })
+        })
+      })
     })
 
     describe('subject contains text nodes', () => {

diff --git a/packages/driver/src/dom/elements/find.ts b/packages/driver/src/dom/elements/find.ts
@@ -4,7 +4,7 @@ import $document from '../document'
 import $jquery from '../jquery'
 import { getTagName } from './elementHelpers'
 import { isWithinShadowRoot, getShadowElementFromPoint } from './shadow'
-import { normalizeWhitespaces, escapeQuotes, isSelector } from './utils'
+import { normalizeWhitespaces, escapeQuotes } from './utils'
 
 /**
  * Find Parents relative to an initial element
@@ -125,10 +125,16 @@ export const getFirstDeepestElement = ($el: JQuery, index = 0) => {
   const $current = $el.slice(index, index + 1)
   const $next = $el.slice(index + 1, index + 2)
 
-  if (!$next) {
+  if (!$next || $current.length === 0) {
     return $current
   }
 
+  // https://github.com/cypress-io/cypress/issues/14861
+  // filter out the <script> and <style> tags
+  if ($current && ['SCRIPT', 'STYLE'].includes($current.prop('tagName'))) {
+    return getFirstDeepestElement($el, index + 1)
+  }
+
   // does current contain next?
   if ($.contains($current.get(0), $next.get(0))) {
     return getFirstDeepestElement($el, index + 1)
@@ -217,20 +223,6 @@ export const getElements = ($el) => {
   return els
 }
 
-// Remove <style> and <script> elements inside <body>. Even though the contains
-// selector avoids selecting them with :not(script,style), it will find the
-// text anyway and attribute it to the <body>
-// https://github.com/cypress-io/cypress/issues/14861
-const removeScriptAndStyleElements = (elem) => {
-  const $elem = $(elem)
-
-  if (!isSelector($elem, 'body')) return elem
-
-  $elem.find('script,style').remove()
-
-  return $elem[0]
-}
-
 export const getContainsSelector = (text, filter = '', options: {
   matchCase?: boolean
 } = {}) => {
@@ -252,14 +244,12 @@ export const getContainsSelector = (text, filter = '', options: {
 
     // taken from jquery's normal contains method
     cyContainsSelector = function (elem) {
-      elem = removeScriptAndStyleElements(elem)
-      let testText = normalizeWhitespaces(elem)
+      const testText = normalizeWhitespaces(elem)
 
       return text.test(testText)
     }
   } else if (_.isString(text)) {
     cyContainsSelector = function (elem) {
-      elem = removeScriptAndStyleElements(elem)
       let testText = normalizeWhitespaces(elem)
 
       if (!options.matchCase) {
@@ -284,7 +274,7 @@ export const getContainsSelector = (text, filter = '', options: {
     const textToFind = escapedText.includes(`\'`) ? `"${escapedText}"` : `'${escapedText}'`
 
     // use custom cy-contains selector that is registered above
-    return `${filter}:not(script,style):cy-contains(${textToFind}), ${filter}[type='submit'][value~=${textToFind}]`
+    return `${filter}:cy-contains(${textToFind}), ${filter}[type='submit'][value~=${textToFind}]`
   })
 
   return selectors.join()