2020-04-16 09:39:33 -07:00
# Working With Network
Playwright provides APIs to **monitor** and **modify** network traffic, both HTTP and HTTPS.
Any requests that page does, including [XHRs ](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest ) and
[fetch ](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API ) requests, can be tracked and modified.
> **NOTE** As of playwright v0.13.0, Playwright is not yet capable of tracking websocket messages.
## Monitor all network activity in page
```js
2020-04-16 10:48:38 -07:00
const { chromium, webkit, firefox } = require('playwright');
(async () => {
const browser = await chromium.launch();
const page = await browser.newPage();
// Subscribe to 'request' and 'response' events.S
page.on('request', request =>
console.log('>>', request.method(), request.url()));
page.on('response', response =>
console.log('< < ', response.status(), response.url()));
await page.goto('https://example.com');
await browser.close();
})();
2020-04-16 09:39:33 -07:00
```
#### API reference
2020-04-16 10:48:38 -07:00
- [`Request` ](./api.md#class-request )
- [`Response` ](./api.md#class-response )
2020-04-16 09:39:33 -07:00
- [`event: 'request'` ](./api.md#event-request )
- [`event: 'response'` ](./api.md#event-response )
2020-04-16 10:48:38 -07:00
< br / >
2020-04-16 09:39:33 -07:00
2020-04-16 10:48:38 -07:00
## Wait for a network response after the button click
2020-04-16 09:39:33 -07:00
```js
const [response] = await Promise.all([
page.waitForResponse('/api/fetch_data'),
2020-04-16 10:48:38 -07:00
page.click('button#update '),
]);
```
The snippet above clicks a button and waits for the network response that matches the given pattern.
#### Variations
```js
// User glob URL pattern
const [response] = await Promise.all([
page.waitForResponse('**/*'),
page.click('button#update '),
]);
// User pattern predicate
const [response] = await Promise.all([
page.waitForResponse(url => url.includes(token)),
page.click('button#update '),
2020-04-16 09:39:33 -07:00
]);
```
#### API reference
- [`page.waitForRequest(urlOrPredicate[, options])` ](./api.md#pagewaitforrequesturlorpredicate -options)
- [`page.waitForResponse(urlOrPredicate[, options])` ](./api.md#pagewaitforresponseurlorpredicate -options)
2020-04-16 10:48:38 -07:00
< br / >
2020-04-16 09:39:33 -07:00
2020-04-16 10:48:38 -07:00
## Mock API endpoint with the test data
2020-04-16 09:39:33 -07:00
```js
await page.route('/api/fetch_data', route => route.fulfill({
status: 200,
body: testData,
}));
await page.goto('https://example.com');
```
You can also use [`browserContext.route` ](./api.md#browsercontextrouteurl-handler ) to mock
API endpoints for all the pages in the context.
2020-04-16 10:48:38 -07:00
#### Variations
```js
// Set up route on the entire browser context.
// It will apply to popup windows and opened links.
await browserContext.route('/api/login', route => route.fulfill({
status: 200,
body: 'accept',
}));
await page.goto('https://example.com');
```
2020-04-16 09:39:33 -07:00
#### API reference
- [`browserContext.route(url, handler)` ](./api.md#browsercontextrouteurl-handler )
2020-04-16 10:48:38 -07:00
- [`browserContext.unroute(url[, handler])` ](./api.md#browsercontextunrouteurl -handler)
- [`page.route(url, handler)` ](./api.md#pagerouteurl-handler )
- [`page.unroute(url[, handler])` ](./api.md#pageunrouteurl -handler)
- [`Route` ](./api.md#class-route )
2020-04-16 09:39:33 -07:00
2020-04-16 10:48:38 -07:00
< br / >
2020-04-16 09:39:33 -07:00
2020-04-16 10:48:38 -07:00
## Abort selected requests
2020-04-16 09:39:33 -07:00
```js
const page = await browser.newPage();
await page.route('**/*.{png,jpg,jpeg}', route => route.abort());
await page.goto('https://example.com');
```
2020-04-16 10:48:38 -07:00
#### Variations
```js
// Abort requests based on their type.
await page.route('**/*', route => {
return route.request().resourceType() === 'image' ?
route.abort() : route.continue();
});
await page.goto('https://chromium.org');
```
2020-04-16 09:39:33 -07:00
#### API reference
- [`page.route(url, handler)` ](./api.md#pagerouteurl-handler )
- [`browserContext.route(url, handler)` ](./api.md#browsercontextrouteurl-handler )
- [`route.abort([errorCode])` ](./api.md#routeaborterrorcode )
2020-04-16 10:48:38 -07:00
< br / >
## Modify selected requests
```js
await page.route('**/*', route => {
const headers = route.request().headers();
delete headers['X-Secret'];
route.continue({headers});
});
await page.goto('https://chromium.org');
```
You can continue requests with modifications. Example above removes an HTTP header from the outgoing requests.
#### Variations
```js
// Continue requests as POST.
await page.route('**/*', route =>
route.continue({method: 'POST'}));
await page.goto('https://chromium.org');
```
2020-04-16 09:39:33 -07:00
2020-04-16 10:48:38 -07:00
< br / >
2020-04-16 09:39:33 -07:00
## Setup [HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication)
```js
const context = await browser.newContext({
httpCredentials: {
username: 'bill',
password: 'pa55w0rd',
},
});
const page = await context.newPage();
awat page.goto('https://example.com');
```
You can also use [`browserContext.setHTTPCredentials` ](./api.md#browsercontextsethttpcredentialshttpcredentials ) to update HTTP credentials of an existing context.
#### API reference
- [`browser.newContext([options])` ](./api.md#browsernewcontextoptions )
- [`browserContext.setHTTPCredentials(httpCredentials)` ](./api.md#browsercontextsethttpcredentialshttpcredentials )