playwright/docs/verification.md

Verification

• Videos
• Screenshots
• Console logs
• Page errors
• Page events

Videos

Playwright can record videos for all pages in a browser context. Videos are saved upon context closure, so make sure to await browserContext.close().

// With browser.newContext()
const context = await browser.newContext({ videosPath: 'videos/' });
// Make sure to await close, so that videos are saved.
await context.close();

// With browser.newPage()
const page = await browser.newPage({ videosPath: '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({
    videosPath: 'videos/',
    videoSize: { width: 800, height: 600 }
});

API reference

• class BrowserContext
• browser.newContext([options])
• browser.newPage([options])
• browserContext.close()

Screenshots

// Save to file
await page.screenshot({ path: 'screenshot.png' });

// Capture full page
await page.screenshot({ path: 'screenshot.png', fullPage: true });

// Capture into buffer
const buffer = await page.screenshot();
console.log(buffer.toString('base64'));

// Capture given element
const elementHandle = await page.$('.header');
await elementHandle.screenshot({ path: 'screenshot.png' });

API reference

• page.screenshot([options])
• elementHandle.screenshot([options])

Console logs

Console messages logged in the page can be brought into the Node.js context.

// Listen for all console logs
page.on('console', msg => console.log(msg.text()))

// Listen for all console events and handle errors
page.on('console', msg => {
  if (msg.type() === 'error')
    console.log(`Error text: "${msg.text()}"`);
});

// 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

API reference

• class: ConsoleMessage
• class: Page
• event: 'console'

Page errors

Listen for uncaught exceptions in the page with the pagerror event.

// 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>');

API reference

• class: Page
• event: 'pageerror'

Page events

"requestfailed"

page.on('requestfailed', request => {
  console.log(request.url() + ' ' + request.failure().errorText);
});

"dialog" - handle alert, confirm, prompt

page.on('dialog', dialog => {
  dialog.accept();
});

"popup" - handle popup windows

const [popup] = await Promise.all([
  page.waitForEvent('popup'),
  page.click('#open')
]);

API reference

• class: Page
• event: 'requestfailed'
• event: 'dialog'
• event: 'popup'