Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add RWA cy.intercept use cases #3742

Merged
merged 7 commits into from
Mar 29, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions content/api/commands/intercept.md
Original file line number Diff line number Diff line change
Expand Up @@ -487,6 +487,32 @@ cy.wait('@headers')
.should('have.property', 'x-custom-headers', 'added by cy.intercept')
```
#### Add, modify or delete a header to all outgoing requests
You can add, modify or delete a header to all outgoing requests using a `beforeEach()` in the `cypress/support/index.js` file
```ts
// Code from Real World App (RWA)
// cypress/support/index.ts
import './commands'

beforeEach(() => {
cy.intercept(
{ url: 'http://localhost:3001', middleware: true },
// Delete 'if-none-match' header from all outgoing requests
(req) => delete req.headers['if-none-match']
)
})
```
<Alert type="info">
##### <Icon name="graduation-cap"></Icon> Real World Example
Clone the <Icon name="github"></Icon> [Real World App (RWA)](https://github.com/cypress-io/cypress-realworld-app) and refer to the [cypress/support/index.ts](https://github.com/cypress-io/cypress-realworld-app/blob/develop/cypress/support/index.ts) file for a working example.
</Alert>
#### Dynamically stubbing a response
You can use the `req.reply()` function to dynamically control the response to a request.
Expand Down Expand Up @@ -663,6 +689,35 @@ The available functions on `res` are:
}
```
#### Throttle or delay response all incoming responses
You can throttle or delay all incoming responses using a `beforeEach()` in the `cypress/support/index.js` file
```ts
// Code from Real World App (RWA)
// cypress/support/index.ts
import { isMobile } from './utils'
import './commands'

// Throttle API responses for mobile testing to simulate real world conditions
if (isMobile()) {
cy.intercept({ url: 'http://localhost:3001', middleware: true }, (req) => {
req.on('response', (res) => {
// Throttle the response to 1 Mbps to simulate a mobile 3G connection
res.throttle(1000)
})
})
}
```
<Alert type="info">
##### <Icon name="graduation-cap"></Icon> Real World Example
Clone the <Icon name="github"></Icon> [Real World App (RWA)](https://github.com/cypress-io/cypress-realworld-app) and refer to the [cypress/support/index.ts](https://github.com/cypress-io/cypress-realworld-app/blob/develop/cypress/support/index.ts) file for a working example.
</Alert>
## History
| Version | Changes |
Expand Down