playwright/docs/verification.md

159 lines
3.7 KiB
Markdown
Raw Normal View History

# Verification
2020-04-21 02:56:46 +03:00
<!-- GEN:toc-top-level -->
- [Videos](#videos)
- [Screenshots](#screenshots)
- [Console logs](#console-logs)
- [Page errors](#page-errors)
2020-04-21 03:17:10 +03:00
- [Page events](#page-events)
<!-- GEN:stop -->
2020-04-21 02:56:46 +03:00
<br/>
## Videos
Playwright can record videos for all pages in a [browser context](core-concepts.md#browser-contexts). Videos are saved upon context closure, so make sure to await `browserContext.close()`.
```js
// With browser.newContext()
const context = await browser.newContext({ recordVideo: { dir: 'videos/' } });
// Make sure to await close, so that videos are saved.
await context.close();
// With browser.newPage()
const page = await browser.newPage({ recordVideo: { dir: 'videos/' } });
// Make sure to await close, so that videos are saved.
await page.close();
// [Optional] Specify video size; defaults to viewport size
const context = await browser.newContext({
recordVideo: {
dir: 'videos/',
size: { width: 800, height: 600 },
}
});
```
#### API reference
- [class `BrowserContext`](./api.md#class-browsercontext)
- [browser.newContext([options])](./api.md#browsernewcontextoptions)
- [browser.newPage([options])](./api.md#browsernewpageoptions)
- [browserContext.close()](./api.md#browsercontextclose)
## Screenshots
2020-04-21 02:56:46 +03:00
```js
// Save to file
await page.screenshot({ path: 'screenshot.png' });
2020-04-21 03:17:10 +03:00
// Capture full page
await page.screenshot({ path: 'screenshot.png', fullPage: true });
2020-04-21 03:17:10 +03:00
// Capture into buffer
2020-04-21 03:17:10 +03:00
const buffer = await page.screenshot();
console.log(buffer.toString('base64'));
2020-04-21 02:56:46 +03:00
// Capture given element
const elementHandle = await page.$('.header');
await elementHandle.screenshot({ path: 'screenshot.png' });
```
2020-04-21 02:56:46 +03:00
#### API reference
- [page.screenshot([options])](./api.md#pagescreenshotoptions)
2020-04-21 03:17:10 +03:00
- [elementHandle.screenshot([options])](./api.md#elementhandlescreenshotoptions)
2020-04-21 02:56:46 +03:00
<br/>
## Console logs
2020-04-21 02:56:46 +03:00
Console messages logged in the page can be brought into the Node.js context.
2020-04-21 02:56:46 +03:00
```js
// Listen for all console logs
page.on('console', msg => console.log(msg.text()))
// Listen for all console events and handle errors
2020-04-21 03:17:10 +03:00
page.on('console', msg => {
if (msg.type() === 'error')
console.log(`Error text: "${msg.text()}"`);
2020-04-21 03:17:10 +03:00
});
// Get the next console log
const [msg] = await Promise.all([
page.waitForEvent('console'),
// Issue console.log inside the page
page.evaluate(() => {
console.log('hello', 42, { foo: 'bar' });
}),
]);
// Deconstruct console log arguments
await msg.args[0].jsonValue() // hello
await msg.args[1].jsonValue() // 42
2020-04-21 02:56:46 +03:00
```
#### API reference
2020-04-21 21:28:08 +03:00
- [class: ConsoleMessage](./api.md#class-consolemessage)
2020-04-21 03:17:10 +03:00
- [class: Page](./api.md#class-page)
- [event: 'console'](./api.md#event-console)
2020-04-21 02:56:46 +03:00
<br/>
## Page errors
2020-04-21 02:56:46 +03:00
Listen for uncaught exceptions in the page with the `pagerror` event.
2020-04-21 03:17:10 +03:00
2020-04-21 02:56:46 +03:00
```js
2020-04-21 03:17:10 +03:00
// Log all uncaught errors to the terminal
page.on('pageerror', exception => {
console.log(`Uncaught exception: "${exception}"`);
});
// Navigate to a page with an exception.
await page.goto('data:text/html,<script>throw new Error("Test")</script>');
2020-04-21 02:56:46 +03:00
```
#### API reference
- [class: Page](./api.md#class-page)
2020-04-21 03:17:10 +03:00
- [event: 'pageerror'](./api.md#event-pageerror)
2020-04-21 02:56:46 +03:00
<br/>
## Page events
#### `"requestfailed"`
```js
page.on('requestfailed', request => {
console.log(request.url() + ' ' + request.failure().errorText);
});
```
#### `"dialog"` - handle alert, confirm, prompt
```js
page.on('dialog', dialog => {
dialog.accept();
});
```
#### `"popup"` - handle popup windows
```js
const [popup] = await Promise.all([
page.waitForEvent('popup'),
page.click('#open')
]);
```
#### API reference
- [class: Page](./api.md#class-page)
- [event: 'requestfailed'](./api.md#event-requestfailed)
- [event: 'dialog'](./api.md#event-dialog)
- [event: 'popup'](./api.md#event-popup)