5.0.0 Release (cypress-io#430)

* rename 'whitelist' to 'ignore' for cy.server() * Rename uses of 'whitelist' for cookies to 'preserve' * fix onBeforeScreenshot and onAfterScreenshot types * conditionally skip tests * ts-ignore * get the checks right * remove need for semver dep Co-authored-by: Brian Mann <[email protected]> Co-authored-by: Gleb Bahmutov <[email protected]> Co-authored-by: Chris Breiding <[email protected]> Co-authored-by: Chris Breiding <[email protected]>
cobenash · Aug 18, 2020 · 6b82d2c · 6b82d2c
1 parent c42cf3b
commit 6b82d2c
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 13 deletions.
diff --git a/app/commands/network-requests.html b/app/commands/network-requests.html
@@ -93,8 +93,8 @@ <h4 id="server"><a href="https://on.cypress.io/server">cy.server()</a></h4>
   expect(server.enable).to.be.true
   // forces requests that don't match your routes to 404
   expect(server.force404).to.be.false
-  // whitelists requests from ever being logged or stubbed
-  expect(server.whitelist).to.be.a('function')
+  // ignores requests from ever being logged or stubbed
+  expect(server.ignore).to.be.a('function')
 })
 
 cy.server({

diff --git a/app/cypress-api.html b/app/cypress-api.html
@@ -120,7 +120,7 @@ <h4 id="Cookies.preserveOnce"><a href="https://on.cypress.io/cookies">Cypress.Co
           <h4 id="Cookies.default"><a href="https://on.cypress.io/cookies">Cypress.Cookies.default()</a></h4>
           <p>To set defaults for all cookies, use <a href="https://on.cypress.io/cookies"><code>Cypress.Cookies.default()</code></a>.</p>
           <pre><code class="javascript">Cypress.Cookies.defaults({
-  whitelist: 'session_id'
+  preserve: 'session_id'
 })</code></pre>
         </div>
 
@@ -132,8 +132,8 @@ <h4 id="Server.default"><a href="https://on.cypress.io/cypress-server">Cypress.S
           <pre><code class="javascript">Cypress.Server.defaults({
   delay: 0,
   force404: true,
-  whitelist: function(xhr){
-    // handle custom logic for whitelisting
+  ignore: function(xhr){
+    // handle custom logic for ignoring XHRs
   }
 })</code></pre>
         </div>

diff --git a/cypress/integration/examples/cypress_api.spec.js b/cypress/integration/examples/cypress_api.spec.js
@@ -65,10 +65,13 @@ context('Cypress.Cookies', () => {
   })
 
   it('.defaults() - set defaults for all cookies', () => {
+    if (Number(Cypress.version.charAt(0)) < 5) return
+
     // now any cookie with the name 'session_id' will
     // not be cleared before each new test runs
     Cypress.Cookies.defaults({
-      whitelist: 'session_id',
+      // @ts-ignore
+      preserve: 'session_id',
     })
   })
 })

diff --git a/cypress/integration/examples/network_requests.spec.js b/cypress/integration/examples/network_requests.spec.js
@@ -29,8 +29,12 @@ context('Network Requests', () => {
       expect(server.enable).to.be.true
       // forces requests that don't match your routes to 404
       expect(server.force404).to.be.false
-      // whitelists requests from ever being logged or stubbed
-      expect(server.whitelist).to.be.a('function')
+
+      if (Number(Cypress.version.charAt(0)) >= 5) {
+        // ignores requests from ever being logged or stubbed
+        // @ts-ignore
+        expect(server.ignore).to.be.a('function')
+      }
     })
 
     cy.server({

diff --git a/package-lock.json b/package-lock.json