fix: confirm GET vs POST listen

bahmutov · Sep 22, 2022 · c1cebd7 · c1cebd7
1 parent 08bd9e3
commit c1cebd7
Show file tree

Hide file tree

Showing 4 changed files with 92 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -108,6 +108,34 @@ cy.waitForNetworkIdle(2000)
   .should('be.within', 2000, 3000)
 ```
 
+## Limit the intercept
+
+You can limit which requests to consider by using `method` and `pattern` parameters. For example, see the spec [get-vs-post.js](./cypress/e2e/get-vs-post.js)
+
+```js
+// listen to all POST calls
+cy.waitForNetworkIdlePrepare({
+  method: 'POST',
+  pattern: '*',
+  alias: 'postCalls',
+})
+
+cy.visit('/get-vs-post')
+cy.waitForNetworkIdle('@postCalls', 2000)
+```
+
+```js
+// listen to "POST /add-user" calls
+cy.waitForNetworkIdlePrepare({
+  method: 'POST',
+  pattern: '/add-user',
+  alias: 'addUser',
+})
+
+cy.visit('/get-vs-post')
+cy.waitForNetworkIdle('@addUser', 2000)
+```
+
 ## Overwrite commands
 
 If you always want to want for network idle when calling `cy.visit` you can overwrite this command using the provided code in [src/register.js](./src/register.js) file

diff --git a/cypress/e2e/get-vs-post.js b/cypress/e2e/get-vs-post.js
@@ -0,0 +1,36 @@
+/// <reference path="../../src/index.d.ts" />
+// @ts-check
+
+import '../..'
+
+describe('Waiting for POST requests', () => {
+  it('ignores the GET requests', () => {
+    // listen to all POST calls
+    cy.waitForNetworkIdlePrepare({
+      method: 'POST',
+      pattern: '*',
+      alias: 'postCalls',
+    })
+
+    cy.visit('/get-vs-post')
+    cy.waitForNetworkIdle('@postCalls', 2000).then(({ waited, callCount }) => {
+      expect(callCount, 'call count').to.equal(1)
+      expect(waited, 'waited period').to.be.within(3500, 4500)
+    })
+  })
+
+  it('waits for specific POST route only', () => {
+    // listen to "POST /add-user" calls
+    cy.waitForNetworkIdlePrepare({
+      method: 'POST',
+      pattern: '/add-user',
+      alias: 'addUser',
+    })
+
+    cy.visit('/get-vs-post')
+    cy.waitForNetworkIdle('@addUser', 2000).then(({ waited, callCount }) => {
+      expect(callCount, 'call count').to.equal(1)
+      expect(waited, 'waited period').to.be.within(3500, 4500)
+    })
+  })
+})
diff --git a/server/get-vs-post.html b/server/get-vs-post.html
@@ -0,0 +1,22 @@
+<html>
+  <head>
+    <title>Get vs post</title>
+  </head>
+  <body>
+    <h1>cypress-network-idle page with lots of GET requests</h1>
+    <p>but only a few POST requests</p>
+    <script>
+      // make constant GET requests
+      setInterval(() => {
+        fetch('/user')
+      }, 1000)
+
+      // make a single POST request
+      setTimeout(() => {
+        fetch('/add-user', {
+          method: 'POST',
+        })
+      }, 1500)
+    </script>
+  </body>
+</html>
diff --git a/server/index.js b/server/index.js
@@ -18,6 +18,10 @@ const user = (req, res) => {
   })
 }
 
+const addUser = (req, res) => {
+  micro.send(res, 200)
+}
+
 const userDelayed = (req, res) => {
   setTimeout(() => {
     micro.send(res, 200, {
@@ -46,4 +50,6 @@ module.exports = dispatch()
   .dispatch('/after', 'GET', sendHtml('after.html'))
   .dispatch('/after/:ms', 'GET', afterMs)
   .dispatch('/busy-page', 'GET', sendHtml('busy-page.html'))
+  .dispatch('/get-vs-post', 'GET', sendHtml('get-vs-post.html'))
+  .dispatch('/add-user', 'POST', addUser)
   .otherwise(html)