248 lines
9.3 KiB
Markdown
248 lines
9.3 KiB
Markdown
---
|
|
id: network
|
|
title: "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, modified and handled.
|
|
|
|
- [HTTP Authentication](#http-authentication)
|
|
- [Handle file downloads](#handle-file-downloads)
|
|
- [Network events](#network-events)
|
|
- [Handle requests](#handle-requests)
|
|
- [Modify requests](#modify-requests)
|
|
- [Abort requests](#abort-requests)
|
|
|
|
<br/>
|
|
|
|
## HTTP Authentication
|
|
|
|
```js
|
|
const context = await browser.newContext({
|
|
httpCredentials: {
|
|
username: 'bill',
|
|
password: 'pa55w0rd',
|
|
},
|
|
});
|
|
const page = await context.newPage();
|
|
await page.goto('https://example.com');
|
|
```
|
|
|
|
#### API reference
|
|
- [browser.newContext([options])](api/class-browser.md#browsernewcontextoptions)
|
|
|
|
<br/>
|
|
|
|
## Handle file downloads
|
|
|
|
```js
|
|
const [ download ] = await Promise.all([
|
|
page.waitForEvent('download'), // <-- start waiting for the download
|
|
page.click('button#delayed-download') // <-- perform the action that directly or indirectly initiates it.
|
|
]);
|
|
const path = await download.path();
|
|
```
|
|
|
|
For every attachment downloaded by the page, [page.on('download')](api/class-page.md#pageondownload) event is emitted. If you create a browser context with the `acceptDownloads: true`, all these attachments are going to be downloaded into a temporary folder. You can obtain the download url, file system path and payload stream using the [Download] object from the event.
|
|
|
|
#### Variations
|
|
|
|
If you have no idea what initiates the download, you can still handle the event:
|
|
|
|
```js
|
|
page.on('download', download => download.path().then(console.log));
|
|
```
|
|
|
|
Note that handling the event forks the control flow and makes script harder to follow. Your scenario might end while you are downloading a file since your main control flow is not awaiting for this operation to resolve.
|
|
|
|
#### API reference
|
|
- [Download]
|
|
- [page.on('download')](api/class-page.md#pageondownload)
|
|
- [page.waitForEvent(event[, optionsOrPredicate])](api/class-page.md#pagewaitforeventevent-optionsorpredicate)
|
|
|
|
<br/>
|
|
|
|
## Network events
|
|
|
|
You can monitor all the requests and responses:
|
|
|
|
```js
|
|
const { chromium, webkit, firefox } = require('playwright');
|
|
|
|
(async () => {
|
|
const browser = await chromium.launch();
|
|
const page = await browser.newPage();
|
|
|
|
// Subscribe to 'request' and 'response' events.
|
|
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();
|
|
})();
|
|
```
|
|
|
|
Or wait for a network response after the button click:
|
|
|
|
```js
|
|
// Use a glob URL pattern
|
|
const [response] = await Promise.all([
|
|
page.waitForResponse('**/api/fetch_data'),
|
|
page.click('button#update'),
|
|
]);
|
|
```
|
|
|
|
#### Variations
|
|
|
|
```js
|
|
// Use a RegExp
|
|
const [response] = await Promise.all([
|
|
page.waitForResponse(/\.jpeg$/),
|
|
page.click('button#update'),
|
|
]);
|
|
|
|
// Use a predicate taking a Response object
|
|
const [response] = await Promise.all([
|
|
page.waitForResponse(response => response.url().includes(token)),
|
|
page.click('button#update'),
|
|
]);
|
|
```
|
|
|
|
#### API reference
|
|
- [Request]
|
|
- [Response]
|
|
- [page.on('request')](api/class-page.md#pageonrequest)
|
|
- [page.on('response')](api/class-page.md#pageonresponse)
|
|
- [page.waitForRequest(urlOrPredicate[, options])](api/class-page.md#pagewaitforrequesturlorpredicate-options)
|
|
- [page.waitForResponse(urlOrPredicate[, options])](api/class-page.md#pagewaitforresponseurlorpredicate-options)
|
|
|
|
<br/>
|
|
|
|
## Handle requests
|
|
|
|
```js
|
|
await page.route('**/api/fetch_data', route => route.fulfill({
|
|
status: 200,
|
|
body: testData,
|
|
}));
|
|
await page.goto('https://example.com');
|
|
```
|
|
|
|
You can mock API endpoints via handling the network quests in your Playwright script.
|
|
|
|
#### 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');
|
|
```
|
|
|
|
#### API reference
|
|
- [browserContext.route(url, handler)](api/class-browsercontext.md#browsercontextrouteurl-handler)
|
|
- [browserContext.unroute(url[, handler])](api/class-browsercontext.md#browsercontextunrouteurl-handler)
|
|
- [page.route(url, handler)](api/class-page.md#pagerouteurl-handler)
|
|
- [page.unroute(url[, handler])](api/class-page.md#pageunrouteurl-handler)
|
|
- [Route]
|
|
|
|
<br/>
|
|
|
|
## Modify requests
|
|
|
|
```js
|
|
// Delete header
|
|
await page.route('**/*', route => {
|
|
const headers = route.request().headers();
|
|
delete headers['X-Secret'];
|
|
route.continue({headers});
|
|
});
|
|
|
|
// Continue requests as POST.
|
|
await page.route('**/*', route => route.continue({method: 'POST'}));
|
|
```
|
|
|
|
You can continue requests with modifications. Example above removes an HTTP header from the outgoing requests.
|
|
|
|
## Abort requests
|
|
|
|
```js
|
|
await page.route('**/*.{png,jpg,jpeg}', route => route.abort());
|
|
|
|
// Abort based on the request type
|
|
await page.route('**/*', route => {
|
|
return route.request().resourceType() === 'image' ?
|
|
route.abort() : route.continue();
|
|
});
|
|
```
|
|
|
|
#### API reference
|
|
- [page.route(url, handler)](api/class-page.md#pagerouteurl-handler)
|
|
- [browserContext.route(url, handler)](api/class-browsercontext.md#browsercontextrouteurl-handler)
|
|
- [route.abort([errorCode])](api/class-route.md#routeaborterrorcode)
|
|
|
|
<br/>
|
|
|
|
[Playwright]: api/class-playwright.md "Playwright"
|
|
[Browser]: api/class-browser.md "Browser"
|
|
[BrowserContext]: api/class-browsercontext.md "BrowserContext"
|
|
[Page]: api/class-page.md "Page"
|
|
[Frame]: api/class-frame.md "Frame"
|
|
[ElementHandle]: api/class-elementhandle.md "ElementHandle"
|
|
[JSHandle]: api/class-jshandle.md "JSHandle"
|
|
[ConsoleMessage]: api/class-consolemessage.md "ConsoleMessage"
|
|
[Dialog]: api/class-dialog.md "Dialog"
|
|
[Download]: api/class-download.md "Download"
|
|
[Video]: api/class-video.md "Video"
|
|
[FileChooser]: api/class-filechooser.md "FileChooser"
|
|
[Keyboard]: api/class-keyboard.md "Keyboard"
|
|
[Mouse]: api/class-mouse.md "Mouse"
|
|
[Touchscreen]: api/class-touchscreen.md "Touchscreen"
|
|
[Request]: api/class-request.md "Request"
|
|
[Response]: api/class-response.md "Response"
|
|
[Selectors]: api/class-selectors.md "Selectors"
|
|
[Route]: api/class-route.md "Route"
|
|
[WebSocket]: api/class-websocket.md "WebSocket"
|
|
[TimeoutError]: api/class-timeouterror.md "TimeoutError"
|
|
[Accessibility]: api/class-accessibility.md "Accessibility"
|
|
[Worker]: api/class-worker.md "Worker"
|
|
[BrowserServer]: api/class-browserserver.md "BrowserServer"
|
|
[BrowserType]: api/class-browsertype.md "BrowserType"
|
|
[Logger]: api/class-logger.md "Logger"
|
|
[ChromiumBrowser]: api/class-chromiumbrowser.md "ChromiumBrowser"
|
|
[ChromiumBrowserContext]: api/class-chromiumbrowsercontext.md "ChromiumBrowserContext"
|
|
[ChromiumCoverage]: api/class-chromiumcoverage.md "ChromiumCoverage"
|
|
[CDPSession]: api/class-cdpsession.md "CDPSession"
|
|
[FirefoxBrowser]: api/class-firefoxbrowser.md "FirefoxBrowser"
|
|
[WebKitBrowser]: api/class-webkitbrowser.md "WebKitBrowser"
|
|
[Array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array "Array"
|
|
[Buffer]: https://nodejs.org/api/buffer.html#buffer_class_buffer "Buffer"
|
|
[ChildProcess]: https://nodejs.org/api/child_process.html "ChildProcess"
|
|
[Element]: https://developer.mozilla.org/en-US/docs/Web/API/element "Element"
|
|
[Error]: https://nodejs.org/api/errors.html#errors_class_error "Error"
|
|
[Evaluation Argument]: ./core-concepts.md#evaluationargument "Evaluation Argument"
|
|
[Map]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map "Map"
|
|
[Object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object "Object"
|
|
[Promise]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise "Promise"
|
|
[RegExp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp "RegExp"
|
|
[Serializable]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#Description "Serializable"
|
|
[UIEvent.detail]: https://developer.mozilla.org/en-US/docs/Web/API/UIEvent/detail "UIEvent.detail"
|
|
[URL]: https://nodejs.org/api/url.html "URL"
|
|
[USKeyboardLayout]: ../src/usKeyboardLayout.ts "USKeyboardLayout"
|
|
[UnixTime]: https://en.wikipedia.org/wiki/Unix_time "Unix Time"
|
|
[boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type "Boolean"
|
|
[function]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function "Function"
|
|
[iterator]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols "Iterator"
|
|
[null]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/null "null"
|
|
[number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type "Number"
|
|
[origin]: https://developer.mozilla.org/en-US/docs/Glossary/Origin "Origin"
|
|
[selector]: https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors "selector"
|
|
[Readable]: https://nodejs.org/api/stream.html#stream_class_stream_readable "Readable"
|
|
[string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type "string"
|
|
[xpath]: https://developer.mozilla.org/en-US/docs/Web/XPath "xpath"
|