Source code
Revision control
Copy as Markdown
Other Tools
/**
* @license
* Copyright 2017 Google Inc.
* SPDX-License-Identifier: Apache-2.0
*/
import assert from 'assert';
import fs from 'fs';
import type {ServerResponse} from 'http';
import path from 'path';
import expect from 'expect';
import {KnownDevices, TimeoutError} from 'puppeteer';
import {CDPSession} from 'puppeteer-core/internal/api/CDPSession.js';
import type {HTTPRequest} from 'puppeteer-core/internal/api/HTTPRequest.js';
import type {Metrics, Page} from 'puppeteer-core/internal/api/Page.js';
import type {CdpPage} from 'puppeteer-core/internal/cdp/Page.js';
import type {ConsoleMessage} from 'puppeteer-core/internal/common/ConsoleMessage.js';
import {Deferred} from 'puppeteer-core/internal/util/Deferred.js';
import sinon from 'sinon';
import {getTestState, setupTestBrowserHooks} from './mocha-utils.js';
import {attachFrame, detachFrame, isFavicon, waitEvent} from './utils.js';
describe('Page', function () {
setupTestBrowserHooks();
describe('Page.close', function () {
it('should reject all promises when page is closed', async () => {
const {context} = await getTestState();
const newPage = await context.newPage();
let error!: Error;
await Promise.all([
newPage
.evaluate(() => {
return new Promise(() => {});
})
.catch(error_ => {
return (error = error_);
}),
newPage.close(),
]);
expect(error.message).toContain('Protocol error');
});
it('should not be visible in browser.pages', async () => {
const {browser, context} = await getTestState();
const newPage = await context.newPage();
expect(await browser.pages()).toContain(newPage);
await newPage.close();
expect(await browser.pages()).not.toContain(newPage);
});
it('should run beforeunload if asked for', async () => {
const {context, server, isChrome} = await getTestState();
const newPage = await context.newPage();
await newPage.goto(server.PREFIX + '/beforeunload.html');
// We have to interact with a page so that 'beforeunload' handlers
// fire.
await newPage.click('body');
const pageClosingPromise = newPage.close({runBeforeUnload: true});
const dialog = await waitEvent(newPage, 'dialog');
expect(dialog.type()).toBe('beforeunload');
expect(dialog.defaultValue()).toBe('');
if (isChrome) {
expect(dialog.message()).toBe('');
} else {
expect(dialog.message()).toBeTruthy();
}
await dialog.accept();
await pageClosingPromise;
});
it('should *not* run beforeunload by default', async () => {
const {context, server} = await getTestState();
const newPage = await context.newPage();
await newPage.goto(server.PREFIX + '/beforeunload.html');
// We have to interact with a page so that 'beforeunload' handlers
// fire.
await newPage.click('body');
await newPage.close();
});
it('should set the page close state', async () => {
const {context} = await getTestState();
const newPage = await context.newPage();
expect(newPage.isClosed()).toBe(false);
await newPage.close();
expect(newPage.isClosed()).toBe(true);
});
it('should terminate network waiters', async () => {
const {context, server} = await getTestState();
const newPage = await context.newPage();
const results = await Promise.all([
newPage.waitForRequest(server.EMPTY_PAGE).catch(error => {
return error;
}),
newPage.waitForResponse(server.EMPTY_PAGE).catch(error => {
return error;
}),
newPage.close(),
]);
for (let i = 0; i < 2; i++) {
const message = results[i].message;
expect(message).atLeastOneToContain([
'Target closed',
'Page closed!',
'Frame detached',
]);
expect(message).not.toContain('Timeout');
}
});
});
describe('Page.Events.Load', function () {
it('should fire when expected', async () => {
const {page} = await getTestState();
await Promise.all([waitEvent(page, 'load'), page.goto('about:blank')]);
});
});
describe('removing and adding event handlers', () => {
it('should correctly fire event handlers as they are added and then removed', async () => {
const {page, server} = await getTestState();
const handler = sinon.spy();
const onResponse = (response: {url: () => string}) => {
// Ignore default favicon requests.
if (!isFavicon(response)) {
handler();
}
};
page.on('response', onResponse);
await page.goto(server.EMPTY_PAGE);
expect(handler.callCount).toBe(1);
page.off('response', onResponse);
await page.goto(server.EMPTY_PAGE);
// Still one because we removed the handler.
expect(handler.callCount).toBe(1);
page.on('response', onResponse);
await page.goto(server.EMPTY_PAGE);
// Two now because we added the handler back.
expect(handler.callCount).toBe(2);
});
it('should correctly added and removed request events', async () => {
const {page, server} = await getTestState();
const handler = sinon.spy();
const onResponse = (response: {url: () => string}) => {
// Ignore default favicon requests.
if (!isFavicon(response)) {
handler();
}
};
page.on('request', onResponse);
page.on('request', onResponse);
await page.goto(server.EMPTY_PAGE);
expect(handler.callCount).toBe(2);
page.off('request', onResponse);
await page.goto(server.EMPTY_PAGE);
// Still one because we removed the handler.
expect(handler.callCount).toBe(3);
page.off('request', onResponse);
await page.goto(server.EMPTY_PAGE);
expect(handler.callCount).toBe(3);
page.on('request', onResponse);
await page.goto(server.EMPTY_PAGE);
// Two now because we added the handler back.
expect(handler.callCount).toBe(4);
});
});
describe('Page.Events.error', function () {
it('should throw when page crashes', async () => {
const {page, isChrome} = await getTestState();
let navigate: Promise<unknown>;
if (isChrome) {
} else {
navigate = page.goto('about:crashcontent').catch(() => {});
}
const [error] = await Promise.all([
waitEvent<Error>(page, 'error'),
navigate,
]);
expect(error.message).toBe('Page crashed!');
});
});
describe('Page.Events.Popup', function () {
it('should work', async () => {
const {page} = await getTestState();
const [popup] = await Promise.all([
waitEvent<Page>(page, 'popup'),
page.evaluate(() => {
return window.open('about:blank');
}),
]);
expect(
await page.evaluate(() => {
return !!window.opener;
})
).toBe(false);
expect(
await popup.evaluate(() => {
return !!window.opener;
})
).toBe(true);
});
it('should work with noopener', async () => {
const {page} = await getTestState();
const [popup] = await Promise.all([
waitEvent<Page>(page, 'popup'),
page.evaluate(() => {
return window.open('about:blank', undefined, 'noopener');
}),
]);
expect(
await page.evaluate(() => {
return !!window.opener;
})
).toBe(false);
expect(
await popup.evaluate(() => {
return !!window.opener;
})
).toBe(false);
});
it('should work with clicking target=_blank and without rel=opener', async () => {
const {page, server} = await getTestState();
await page.goto(server.EMPTY_PAGE);
await page.setContent('<a target=_blank href="/one-style.html">yo</a>');
const [popup] = await Promise.all([
waitEvent<Page>(page, 'popup'),
page.click('a'),
]);
expect(
await page.evaluate(() => {
return !!window.opener;
})
).toBe(false);
expect(
await popup.evaluate(() => {
return !!window.opener;
})
).toBe(false);
});
it('should work with clicking target=_blank and with rel=opener', async () => {
const {page, server} = await getTestState();
await page.goto(server.EMPTY_PAGE);
await page.setContent(
'<a target=_blank rel=opener href="/one-style.html">yo</a>'
);
const [popup] = await Promise.all([
waitEvent<Page>(page, 'popup'),
page.click('a'),
]);
expect(
await page.evaluate(() => {
return !!window.opener;
})
).toBe(false);
expect(
await popup.evaluate(() => {
return !!window.opener;
})
).toBe(true);
});
it('should work with fake-clicking target=_blank and rel=noopener', async () => {
const {page, server} = await getTestState();
await page.goto(server.EMPTY_PAGE);
await page.setContent(
'<a target=_blank rel=noopener href="/one-style.html">yo</a>'
);
const [popup] = await Promise.all([
waitEvent<Page>(page, 'popup'),
page.$eval('a', a => {
return (a as HTMLAnchorElement).click();
}),
]);
expect(
await page.evaluate(() => {
return !!window.opener;
})
).toBe(false);
expect(
await popup.evaluate(() => {
return !!window.opener;
})
).toBe(false);
});
it('should work with clicking target=_blank and rel=noopener', async () => {
const {page, server} = await getTestState();
await page.goto(server.EMPTY_PAGE);
await page.setContent(
'<a target=_blank rel=noopener href="/one-style.html">yo</a>'
);
const [popup] = await Promise.all([
waitEvent<Page>(page, 'popup'),
page.click('a'),
]);
expect(
await page.evaluate(() => {
return !!window.opener;
})
).toBe(false);
expect(
await popup.evaluate(() => {
return !!window.opener;
})
).toBe(false);
});
});
describe('Page.setGeolocation', function () {
it('should work', async () => {
const {page, server, context} = await getTestState();
await context.overridePermissions(server.PREFIX, ['geolocation']);
await page.goto(server.EMPTY_PAGE);
await page.setGeolocation({longitude: 10, latitude: 10});
const geolocation = await page.evaluate(() => {
return new Promise(resolve => {
return navigator.geolocation.getCurrentPosition(position => {
resolve({
latitude: position.coords.latitude,
longitude: position.coords.longitude,
});
});
});
});
expect(geolocation).toEqual({
latitude: 10,
longitude: 10,
});
});
it('should throw when invalid longitude', async () => {
const {page} = await getTestState();
let error!: Error;
try {
await page.setGeolocation({longitude: 200, latitude: 10});
} catch (error_) {
error = error_ as Error;
}
expect(error.message).toContain('Invalid longitude "200"');
});
});
describe('Page.setOfflineMode', function () {
it('should work', async () => {
const {page, server} = await getTestState();
await page.setOfflineMode(true);
let error!: Error;
await page.goto(server.EMPTY_PAGE).catch(error_ => {
return (error = error_);
});
expect(error).toBeTruthy();
await page.setOfflineMode(false);
const response = (await page.reload())!;
expect(response.status()).toBe(200);
});
it('should emulate navigator.onLine', async () => {
const {page} = await getTestState();
expect(
await page.evaluate(() => {
return window.navigator.onLine;
})
).toBe(true);
await page.setOfflineMode(true);
expect(
await page.evaluate(() => {
return window.navigator.onLine;
})
).toBe(false);
await page.setOfflineMode(false);
expect(
await page.evaluate(() => {
return window.navigator.onLine;
})
).toBe(true);
});
});
describe('Page.Events.Console', function () {
it('should work', async () => {
const {page} = await getTestState();
const [message] = await Promise.all([
waitEvent<ConsoleMessage>(page, 'console'),
page.evaluate(() => {
return console.log('hello', 5, {foo: 'bar'});
}),
]);
expect(message.text()).toEqual('hello 5 JSHandle@object');
expect(message.type()).toEqual('log');
expect(message.args()).toHaveLength(3);
expect(message.location()).toEqual({
url: expect.any(String),
lineNumber: expect.any(Number),
columnNumber: expect.any(Number),
});
expect(await message.args()[0]!.jsonValue()).toEqual('hello');
expect(await message.args()[1]!.jsonValue()).toEqual(5);
expect(await message.args()[2]!.jsonValue()).toEqual({foo: 'bar'});
});
it('should work on script call right after navigation', async () => {
const {page} = await getTestState();
const [message] = await Promise.all([
waitEvent<ConsoleMessage>(page, 'console'),
page.goto(
// Firefox prints warn if <!DOCTYPE html> is not present
`data:text/html,<!DOCTYPE html><script>console.log('SOME_LOG_MESSAGE');</script>`
),
]);
expect(message.text()).toEqual('SOME_LOG_MESSAGE');
});
it('should work for different console API calls with logging functions', async () => {
const {page} = await getTestState();
const messages: ConsoleMessage[] = [];
page.on('console', msg => {
return messages.push(msg);
});
// All console events will be reported before `page.evaluate` is finished.
await page.evaluate(() => {
console.trace('calling console.trace');
console.dir('calling console.dir');
console.warn('calling console.warn');
console.error('calling console.error');
console.log(Promise.resolve('should not wait until resolved!'));
});
expect(
messages.map(msg => {
return msg.type();
})
).toEqual(['trace', 'dir', 'warn', 'error', 'log']);
expect(
messages.map(msg => {
return msg.text();
})
).toEqual([
'calling console.trace',
'calling console.dir',
'calling console.warn',
'calling console.error',
'JSHandle@promise',
]);
});
it('should work for different console API calls with timing functions', async () => {
const {page} = await getTestState();
const messages: any[] = [];
page.on('console', msg => {
return messages.push(msg);
});
// All console events will be reported before `page.evaluate` is finished.
await page.evaluate(() => {
// A pair of time/timeEnd generates only one Console API call.
console.time('calling console.time');
console.timeEnd('calling console.time');
});
expect(
messages.map(msg => {
return msg.type();
})
).toEqual(['timeEnd']);
expect(messages[0]!.text()).toContain('calling console.time');
});
it('should not fail for window object', async () => {
const {page} = await getTestState();
const [message] = await Promise.all([
waitEvent<ConsoleMessage>(page, 'console'),
page.evaluate(() => {
return console.error(window);
}),
]);
expect(message.text()).atLeastOneToContain([
'JSHandle@object',
'JSHandle@window',
]);
});
it('should return remote objects', async () => {
const {page} = await getTestState();
const logPromise = waitEvent<ConsoleMessage>(page, 'console');
await page.evaluate(() => {
(globalThis as any).test = 1;
console.log(1, 2, 3, globalThis);
});
const log = await logPromise;
expect(log.text()).atLeastOneToContain([
'1 2 3 JSHandle@object',
'1 2 3 JSHandle@window',
]);
expect(log.args()).toHaveLength(4);
using property = await log.args()[3]!.getProperty('test');
expect(await property.jsonValue()).toBe(1);
});
it('should trigger correct Log', async () => {
const {page, server, isChrome} = await getTestState();
await page.goto('about:blank');
const [message] = await Promise.all([
waitEvent(page, 'console'),
page.evaluate(async (url: string) => {
return await fetch(url).catch(() => {});
}, server.EMPTY_PAGE),
]);
expect(message.text()).toContain('Access-Control-Allow-Origin');
if (isChrome) {
expect(message.type()).toEqual('error');
} else {
expect(message.type()).toEqual('warn');
}
});
it('should have location when fetch fails', async () => {
const {page, server} = await getTestState();
// The point of this test is to make sure that we report console messages from
await page.goto(server.EMPTY_PAGE);
const [message] = await Promise.all([
waitEvent(page, 'console'),
]);
expect(message.text()).toContain(`ERR_NAME_NOT_RESOLVED`);
expect(message.type()).toEqual('error');
expect(message.location()).toEqual({
lineNumber: undefined,
});
});
it('should have location and stack trace for console API calls', async () => {
const {page, server, isChrome} = await getTestState();
await page.goto(server.EMPTY_PAGE);
const [message] = await Promise.all([
waitEvent(page, 'console'),
page.goto(server.PREFIX + '/consolelog.html'),
]);
expect(message.text()).toBe('yellow');
expect(message.type()).toBe('log');
expect(message.location()).toEqual({
url: server.PREFIX + '/consolelog.html',
lineNumber: 8,
columnNumber: isChrome ? 16 : 8, // console.|log vs |console.log
});
expect(message.stackTrace()).toEqual([
{
url: server.PREFIX + '/consolelog.html',
lineNumber: 8,
columnNumber: isChrome ? 16 : 8, // console.|log vs |console.log
},
{
url: server.PREFIX + '/consolelog.html',
lineNumber: 11,
columnNumber: 8,
},
{
url: server.PREFIX + '/consolelog.html',
lineNumber: 13,
columnNumber: 6,
},
]);
});
it('should not throw when there are console messages in detached iframes', async () => {
const {page, server} = await getTestState();
await page.goto(server.EMPTY_PAGE);
await page.evaluate(async () => {
// 1. Create a popup that Puppeteer is not connected to.
const win = window.open(
window.location.href,
'Title',
'toolbar=no,location=no,directories=no,status=no,menubar=no,scrollbars=yes,resizable=yes,width=780,height=200,top=0,left=0'
)!;
await new Promise(x => {
return (win.onload = x);
});
// 2. In this popup, create an iframe that console.logs a message.
win.document.body.innerHTML = `<iframe src='/consolelog.html'></iframe>`;
const frame = win.document.querySelector('iframe')!;
await new Promise(x => {
return (frame.onload = x);
});
// 3. After that, remove the iframe.
frame.remove();
});
// 4. The target will always be the last one.
const popupTarget = page.browserContext().targets().at(-1)!;
// 5. Connect to the popup and make sure it doesn't throw and is not the same page.
expect(await popupTarget.page()).not.toBe(page);
});
});
describe('Page.Events.DOMContentLoaded', function () {
it('should fire when expected', async () => {
const {page} = await getTestState();
const navigate = page.goto('about:blank');
await Promise.all([waitEvent(page, 'domcontentloaded'), navigate]);
});
});
describe('Page.metrics', function () {
it('should get metrics from a page', async () => {
const {page} = await getTestState();
await page.goto('about:blank');
const metrics = await page.metrics();
checkMetrics(metrics);
});
it('metrics event fired on console.timeStamp', async () => {
const {page} = await getTestState();
const metricsPromise = waitEvent<{metrics: Metrics; title: string}>(
page,
'metrics'
);
await page.evaluate(() => {
return console.timeStamp('test42');
});
const metrics = await metricsPromise;
expect(metrics.title).toBe('test42');
checkMetrics(metrics.metrics);
});
function checkMetrics(metrics: Metrics) {
const metricsToCheck = new Set([
'Timestamp',
'Documents',
'Frames',
'JSEventListeners',
'Nodes',
'LayoutCount',
'RecalcStyleCount',
'LayoutDuration',
'RecalcStyleDuration',
'ScriptDuration',
'TaskDuration',
'JSHeapUsedSize',
'JSHeapTotalSize',
]);
for (const name in metrics) {
expect(metricsToCheck.has(name)).toBeTruthy();
expect(metrics[name as keyof Metrics]).toBeGreaterThanOrEqual(0);
metricsToCheck.delete(name);
}
expect(metricsToCheck.size).toBe(0);
}
});
describe('Page.waitForRequest', function () {
it('should work', async () => {
const {page, server} = await getTestState();
await page.goto(server.EMPTY_PAGE);
const [request] = await Promise.all([
page.waitForRequest(server.PREFIX + '/digits/2.png'),
page.evaluate(() => {
void fetch('/digits/1.png');
void fetch('/digits/2.png');
void fetch('/digits/3.png');
}),
]);
expect(request.url()).toBe(server.PREFIX + '/digits/2.png');
});
it('should work with predicate', async () => {
const {page, server} = await getTestState();
await page.goto(server.EMPTY_PAGE);
const [request] = await Promise.all([
page.waitForRequest(request => {
return request.url() === server.PREFIX + '/digits/2.png';
}),
page.evaluate(() => {
void fetch('/digits/1.png');
void fetch('/digits/2.png');
void fetch('/digits/3.png');
}),
]);
expect(request.url()).toBe(server.PREFIX + '/digits/2.png');
});
it('should work with async predicate', async () => {
const {page, server} = await getTestState();
await page.goto(server.EMPTY_PAGE);
const [request] = await Promise.all([
page.waitForRequest(async request => {
return request.url() === server.PREFIX + '/digits/2.png';
}),
page.evaluate(() => {
void fetch('/digits/1.png');
void fetch('/digits/2.png');
void fetch('/digits/3.png');
}),
]);
expect(request.url()).toBe(server.PREFIX + '/digits/2.png');
});
it('should respect timeout', async () => {
const {page} = await getTestState();
let error!: Error;
await page
.waitForRequest(
() => {
return false;
},
{timeout: 1}
)
.catch(error_ => {
return (error = error_);
});
expect(error).toBeInstanceOf(TimeoutError);
});
it('should respect default timeout', async () => {
const {page} = await getTestState();
let error!: Error;
page.setDefaultTimeout(1);
await page
.waitForRequest(() => {
return false;
})
.catch(error_ => {
return (error = error_);
});
expect(error).toBeInstanceOf(TimeoutError);
});
it('should work with no timeout', async () => {
const {page, server} = await getTestState();
await page.goto(server.EMPTY_PAGE);
const [request] = await Promise.all([
page.waitForRequest(server.PREFIX + '/digits/2.png', {timeout: 0}),
page.evaluate(() => {
return setTimeout(() => {
void fetch('/digits/1.png');
void fetch('/digits/2.png');
void fetch('/digits/3.png');
}, 50);
}),
]);
expect(request.url()).toBe(server.PREFIX + '/digits/2.png');
});
});
describe('Page.waitForResponse', function () {
it('should work', async () => {
const {page, server} = await getTestState();
await page.goto(server.EMPTY_PAGE);
const [response] = await Promise.all([
page.waitForResponse(server.PREFIX + '/digits/2.png'),
page.evaluate(() => {
void fetch('/digits/1.png');
void fetch('/digits/2.png');
void fetch('/digits/3.png');
}),
]);
expect(response.url()).toBe(server.PREFIX + '/digits/2.png');
});
it('should respect timeout', async () => {
const {page} = await getTestState();
let error!: Error;
await page
.waitForResponse(
() => {
return false;
},
{timeout: 1}
)
.catch(error_ => {
return (error = error_);
});
expect(error).toBeInstanceOf(TimeoutError);
});
it('should respect default timeout', async () => {
const {page} = await getTestState();
let error!: Error;
page.setDefaultTimeout(1);
await page
.waitForResponse(() => {
return false;
})
.catch(error_ => {
return (error = error_);
});
expect(error).toBeInstanceOf(TimeoutError);
});
it('should work with predicate', async () => {
const {page, server} = await getTestState();
await page.goto(server.EMPTY_PAGE);
const [response] = await Promise.all([
page.waitForResponse(response => {
return response.url() === server.PREFIX + '/digits/2.png';
}),
page.evaluate(() => {
void fetch('/digits/1.png');
void fetch('/digits/2.png');
void fetch('/digits/3.png');
}),
]);
expect(response.url()).toBe(server.PREFIX + '/digits/2.png');
});
it('should work with async predicate', async () => {
const {page, server} = await getTestState();
await page.goto(server.EMPTY_PAGE);
const [response] = await Promise.all([
page.waitForResponse(async response => {
return response.url() === server.PREFIX + '/digits/2.png';
}),
page.evaluate(() => {
void fetch('/digits/1.png');
void fetch('/digits/2.png');
void fetch('/digits/3.png');
}),
]);
expect(response.url()).toBe(server.PREFIX + '/digits/2.png');
});
it('should work with no timeout', async () => {
const {page, server} = await getTestState();
await page.goto(server.EMPTY_PAGE);
const [response] = await Promise.all([
page.waitForResponse(server.PREFIX + '/digits/2.png', {timeout: 0}),
page.evaluate(() => {
return setTimeout(() => {
void fetch('/digits/1.png');
void fetch('/digits/2.png');
void fetch('/digits/3.png');
}, 50);
}),
]);
expect(response.url()).toBe(server.PREFIX + '/digits/2.png');
});
});
describe('Page.waitForNetworkIdle', function () {
it('should work', async () => {
const {page, server} = await getTestState();
await page.goto(server.EMPTY_PAGE);
let res;
const [t1, t2] = await Promise.all([
page.waitForNetworkIdle().then(r => {
res = r;
return Date.now();
}),
page
.evaluate(async () => {
await Promise.all([fetch('/digits/1.png'), fetch('/digits/2.png')]);
await new Promise(resolve => {
return setTimeout(resolve, 200);
});
await fetch('/digits/3.png');
await new Promise(resolve => {
return setTimeout(resolve, 200);
});
await fetch('/digits/4.png');
})
.then(() => {
return Date.now();
}),
]);
expect(res).toBe(undefined);
expect(t1).toBeGreaterThan(t2);
expect(t1 - t2).toBeGreaterThanOrEqual(400);
});
it('should respect timeout', async () => {
const {page} = await getTestState();
let error!: Error;
await page.waitForNetworkIdle({timeout: 1}).catch(error_ => {
return (error = error_);
});
expect(error).toBeInstanceOf(TimeoutError);
});
it('should respect idleTime', async () => {
const {page, server} = await getTestState();
await page.goto(server.EMPTY_PAGE);
const [t1, t2] = await Promise.all([
page.waitForNetworkIdle({idleTime: 10}).then(() => {
return Date.now();
}),
page
.evaluate(() => {
return (async () => {
await Promise.all([
fetch('/digits/1.png'),
fetch('/digits/2.png'),
]);
await new Promise(resolve => {
return setTimeout(resolve, 250);
});
})();
})
.then(() => {
return Date.now();
}),
]);
expect(t2).toBeGreaterThan(t1);
});
it('should work with no timeout', async () => {
const {page, server} = await getTestState();
await page.goto(server.EMPTY_PAGE);
const [result] = await Promise.all([
page.waitForNetworkIdle({timeout: 0}),
page.evaluate(() => {
return setTimeout(() => {
void fetch('/digits/1.png');
void fetch('/digits/2.png');
void fetch('/digits/3.png');
}, 50);
}),
]);
expect(result).toBe(undefined);
});
it('should work with aborted requests', async () => {
const {page, server} = await getTestState();
await page.goto(server.PREFIX + '/abort-request.html');
using element = await page.$(`#abort`);
await element!.click();
let error = false;
await page.waitForNetworkIdle().catch(() => {
return (error = true);
});
expect(error).toBe(false);
});
it('should work with delayed response', async () => {
const {page, server} = await getTestState();
await page.goto(server.EMPTY_PAGE);
let response!: ServerResponse;
server.setRoute('/fetch-request-b.js', (_req, res) => {
response = res;
});
const t0 = Date.now();
const [t1, t2] = await Promise.all([
page.waitForNetworkIdle({idleTime: 100}).then(() => {
return Date.now();
}),
new Promise<number>(res => {
setTimeout(() => {
response.end();
res(Date.now());
}, 300);
}),
page.evaluate(async () => {
await fetch('/fetch-request-b.js');
}),
]);
expect(t1).toBeGreaterThan(t2);
// request finished + idle time.
expect(t1 - t0).toBeGreaterThan(400);
// request finished + idle time - request finished.
expect(t1 - t2).toBeGreaterThanOrEqual(100);
});
});
describe('Page.exposeFunction', function () {
it('should work', async () => {
const {page} = await getTestState();
await page.exposeFunction('compute', function (a: number, b: number) {
return a * b;
});
const result = await page.evaluate(async function () {
return (globalThis as any).compute(9, 4);
});
expect(result).toBe(36);
});
it('should throw exception in page context', async () => {
const {page} = await getTestState();
await page.exposeFunction('woof', () => {
throw new Error('WOOF WOOF');
});
const {message, stack} = await page.evaluate(async () => {
try {
return await (
globalThis as unknown as {woof(): Promise<never>}
).woof();
} catch (error) {
return {
message: (error as Error).message,
stack: (error as Error).stack,
};
}
});
expect(message).toBe('WOOF WOOF');
expect(stack).toContain('page.spec.ts');
});
it('should support throwing "null"', async () => {
const {page} = await getTestState();
await page.exposeFunction('woof', function () {
throw null;
});
const thrown = await page.evaluate(async () => {
try {
await (globalThis as any).woof();
return;
} catch (error) {
return error;
}
});
expect(thrown).toBe(null);
});
it('should be callable from-inside evaluateOnNewDocument', async () => {
const {page} = await getTestState();
const called = new Deferred<void>();
await page.exposeFunction('woof', function () {
called.resolve();
});
await page.evaluateOnNewDocument(() => {
return (globalThis as any).woof();
});
await page.reload();
await called.valueOrThrow();
});
it('should survive navigation', async () => {
const {page, server} = await getTestState();
await page.exposeFunction('compute', function (a: number, b: number) {
return a * b;
});
await page.goto(server.EMPTY_PAGE);
const result = await page.evaluate(async function () {
return (globalThis as any).compute(9, 4);
});
expect(result).toBe(36);
});
it('should await returned promise', async () => {
const {page} = await getTestState();
await page.exposeFunction('compute', function (a: number, b: number) {
return Promise.resolve(a * b);
});
const result = await page.evaluate(async function () {
return (globalThis as any).compute(3, 5);
});
expect(result).toBe(15);
});
it('should await returned if called from function', async () => {
const {page} = await getTestState();
await page.exposeFunction('compute', function (a: number, b: number) {
return Promise.resolve(a * b);
});
const result = await page.evaluate(async function () {
const result = await (globalThis as any).compute(3, 5);
return result;
});
expect(result).toBe(15);
});
it('should work on frames', async () => {
const {page, server} = await getTestState();
await page.exposeFunction('compute', function (a: number, b: number) {
return Promise.resolve(a * b);
});
await page.goto(server.PREFIX + '/frames/nested-frames.html');
const frame = page.frames()[1]!;
const result = await frame.evaluate(async function () {
return (globalThis as any).compute(3, 5);
});
expect(result).toBe(15);
});
it('should work with loading frames', async () => {
// Tries to reproduce the scenario from
const {page, server} = await getTestState();
await page.setRequestInterception(true);
let saveRequest: (value: HTTPRequest | PromiseLike<HTTPRequest>) => void;
const iframeRequest = new Promise<HTTPRequest>(resolve => {
saveRequest = resolve;
});
page.on('request', async req => {
if (req.url().endsWith('/frames/frame.html')) {
saveRequest(req);
} else {
await req.continue();
}
});
let error: Error | undefined;
const navPromise = page
.goto(server.PREFIX + '/frames/one-frame.html', {
waitUntil: 'networkidle0',
})
.catch(err => {
error = err;
});
const req = await iframeRequest;
// Expose function while the frame is being loaded. Loading process is
// controlled by interception.
const exposePromise = page.exposeFunction(
'compute',
function (a: number, b: number) {
return Promise.resolve(a * b);
}
);
await Promise.all([req.continue(), exposePromise]);
await navPromise;
expect(error).toBeUndefined();
const frame = page.frames()[1]!;
const result = await frame.evaluate(async function () {
return (globalThis as any).compute(3, 5);
});
expect(result).toBe(15);
});
it('should work on frames before navigation', async () => {
const {page, server} = await getTestState();
await page.goto(server.PREFIX + '/frames/nested-frames.html');
await page.exposeFunction('compute', function (a: number, b: number) {
return Promise.resolve(a * b);
});
const frame = page.frames()[1]!;
const result = await frame.evaluate(async function () {
return (globalThis as any).compute(3, 5);
});
expect(result).toBe(15);
});
it('should not throw when frames detach', async () => {
const {page, server} = await getTestState();
await page.goto(server.EMPTY_PAGE);
await attachFrame(page, 'frame1', server.EMPTY_PAGE);
await page.exposeFunction('compute', function (a: number, b: number) {
return Promise.resolve(a * b);
});
await detachFrame(page, 'frame1');
await expect(
page.evaluate(async function () {
return (globalThis as any).compute(3, 5);
})
).resolves.toEqual(15);
});
it('should work with complex objects', async () => {
const {page} = await getTestState();
await page.exposeFunction(
'complexObject',
function (a: {x: number}, b: {x: number}) {
return {x: a.x + b.x};
}
);
const result = await page.evaluate(async () => {
return (globalThis as any).complexObject({x: 5}, {x: 2});
});
expect(result.x).toBe(7);
});
it('should fallback to default export when passed a module object', async () => {
const {page, server} = await getTestState();
const moduleObject = {
default: function (a: number, b: number) {
return a * b;
},
};
await page.goto(server.EMPTY_PAGE);
await page.exposeFunction('compute', moduleObject);
const result = await page.evaluate(async function () {
return (globalThis as any).compute(9, 4);
});
expect(result).toBe(36);
});
});
describe('Page.removeExposedFunction', function () {
it('should work', async () => {
const {page} = await getTestState();
await page.exposeFunction('compute', function (a: number, b: number) {
return a * b;
});
const result = await page.evaluate(async function () {
return (globalThis as any).compute(9, 4);
});
expect(result).toBe(36);
await page.removeExposedFunction('compute');
const error = await page
.evaluate(async function () {
return (globalThis as any).compute(9, 4);
})
.then(() => {
return null;
})
.catch(error => {
return error;
});
expect(error).toBeTruthy();
});
});
describe('Page.Events.PageError', function () {
it('should fire', async () => {
const {page, server} = await getTestState();
const [error] = await Promise.all([
waitEvent<Error>(page, 'pageerror', err => {
return err.message.includes('Fancy');
}),
page.goto(server.PREFIX + '/error.html'),
]);
expect(error.message).toContain('Fancy');
expect(error.stack?.split('\n').at(-1)).toContain('error.html:3:1');
});
});
describe('Page.setUserAgent', function () {
it('should work', async () => {
const {page, server} = await getTestState();
expect(
await page.evaluate(() => {
return navigator.userAgent;
})
).toContain('Mozilla');
await page.setUserAgent('foobar');
const [request] = await Promise.all([
server.waitForRequest('/empty.html'),
page.goto(server.EMPTY_PAGE),
]);
expect(request.headers['user-agent']).toBe('foobar');
});
it('should work for subframes', async () => {
const {page, server} = await getTestState();
expect(
await page.evaluate(() => {
return navigator.userAgent;
})
).toContain('Mozilla');
await page.setUserAgent('foobar');
const [request] = await Promise.all([
server.waitForRequest('/empty.html'),
attachFrame(page, 'frame1', server.EMPTY_PAGE),
]);
expect(request.headers['user-agent']).toBe('foobar');
});
it('should emulate device user-agent', async () => {
const {page, server} = await getTestState();
await page.goto(server.PREFIX + '/mobile.html');
expect(
await page.evaluate(() => {
return navigator.userAgent;
})
).not.toContain('iPhone');
await page.setUserAgent(KnownDevices['iPhone 6'].userAgent);
expect(
await page.evaluate(() => {
return navigator.userAgent;
})
).toContain('iPhone');
});
it('should work with additional userAgentMetdata', async () => {
const {page, server} = await getTestState();
await page.setUserAgent('MockBrowser', {
architecture: 'Mock1',
mobile: false,
model: 'Mockbook',
platform: 'MockOS',
platformVersion: '3.1',
});
const [request] = await Promise.all([
server.waitForRequest('/empty.html'),
page.goto(server.EMPTY_PAGE),
]);
expect(
await page.evaluate(() => {
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-expect-error: userAgentData not yet in TypeScript DOM API
return navigator.userAgentData.mobile;
})
).toBe(false);
const uaData = await page.evaluate(() => {
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-expect-error: userAgentData not yet in TypeScript DOM API
return navigator.userAgentData.getHighEntropyValues([
'architecture',
'model',
'platform',
'platformVersion',
]);
});
expect(uaData['architecture']).toBe('Mock1');
expect(uaData['model']).toBe('Mockbook');
expect(uaData['platform']).toBe('MockOS');
expect(uaData['platformVersion']).toBe('3.1');
expect(request.headers['user-agent']).toBe('MockBrowser');
});
});
describe('Page.setContent', function () {
const expectedOutput =
'<html><head></head><body><div>hello</div></body></html>';
it('should work', async () => {
const {page} = await getTestState();
await page.setContent('<div>hello</div>');
const result = await page.content();
expect(result).toBe(expectedOutput);
});
it('should work with doctype', async () => {
const {page} = await getTestState();
const doctype = '<!DOCTYPE html>';
await page.setContent(`${doctype}<div>hello</div>`);
const result = await page.content();
expect(result).toBe(`${doctype}${expectedOutput}`);
});
it('should work with HTML 4 doctype', async () => {
const {page} = await getTestState();
const doctype =
'<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" ' +
await page.setContent(`${doctype}<div>hello</div>`);
const result = await page.content();
expect(result).toBe(`${doctype}${expectedOutput}`);
});
it('should respect timeout', async () => {
const {page, server} = await getTestState();
const imgPath = '/img.png';
// stall for image
server.setRoute(imgPath, () => {});
let error!: Error;
await page
.setContent(`<img src="${server.PREFIX + imgPath}"></img>`, {
timeout: 1,
})
.catch(error_ => {
return (error = error_);
});
expect(error).toBeInstanceOf(TimeoutError);
});
it('should respect default navigation timeout', async () => {
const {page, server} = await getTestState();
page.setDefaultNavigationTimeout(1);
const imgPath = '/img.png';
// stall for image
server.setRoute(imgPath, () => {});
let error!: Error;
await page
.setContent(`<img src="${server.PREFIX + imgPath}"></img>`)
.catch(error_ => {
return (error = error_);
});
expect(error).toBeInstanceOf(TimeoutError);
});
it('should await resources to load', async () => {
const {page, server} = await getTestState();
const imgPath = '/img.png';
let imgResponse!: ServerResponse;
server.setRoute(imgPath, (_req, res) => {
return (imgResponse = res);
});
let loaded = false;
const contentPromise = page
.setContent(`<img src="${server.PREFIX + imgPath}"></img>`)
.then(() => {
return (loaded = true);
});
await server.waitForRequest(imgPath);
expect(loaded).toBe(false);
imgResponse.end();
await contentPromise;
});
it('should work fast enough', async () => {
const {page} = await getTestState();
for (let i = 0; i < 20; ++i) {
await page.setContent('<div>yo</div>');
}
});
it('should work with tricky content', async () => {
const {page} = await getTestState();
await page.setContent('<div>hello world</div>' + '\x7F');
expect(
await page.$eval('div', div => {
return div.textContent;
})
).toBe('hello world');
});
it('should work with accents', async () => {
const {page} = await getTestState();
await page.setContent('<div>aberración</div>');
expect(
await page.$eval('div', div => {
return div.textContent;
})
).toBe('aberración');
});
it('should work with emojis', async () => {
const {page} = await getTestState();
await page.setContent('<div>🐥</div>');
expect(
await page.$eval('div', div => {
return div.textContent;
})
).toBe('🐥');
});
it('should work with newline', async () => {
const {page} = await getTestState();
await page.setContent('<div>\n</div>');
expect(
await page.$eval('div', div => {
return div.textContent;
})
).toBe('\n');
});
it('should work with comments outside HTML tag', async () => {
const {page} = await getTestState();
const comment = '<!-- Comment -->';
await page.setContent(`${comment}<div>hello</div>`);
const result = await page.content();
expect(result).toBe(`${comment}${expectedOutput}`);
});
});
describe('Page.setBypassCSP', function () {
it('should bypass CSP meta tag', async () => {
const {page, server} = await getTestState();
// Make sure CSP prohibits addScriptTag.
await page.goto(server.PREFIX + '/csp.html');
await page
.addScriptTag({content: 'window.__injected = 42;'})
.catch(error => {
return void error;
});
expect(
await page.evaluate(() => {
return (globalThis as any).__injected;
})
).toBe(undefined);
// By-pass CSP and try one more time.
await page.setBypassCSP(true);
await page.reload();
await page.addScriptTag({content: 'window.__injected = 42;'});
expect(
await page.evaluate(() => {
return (globalThis as any).__injected;
})
).toBe(42);
});
it('should bypass CSP header', async () => {
const {page, server} = await getTestState();
// Make sure CSP prohibits addScriptTag.
server.setCSP('/empty.html', 'default-src "self"');
await page.goto(server.EMPTY_PAGE);
await page
.addScriptTag({content: 'window.__injected = 42;'})
.catch(error => {
return void error;
});
expect(
await page.evaluate(() => {
return (globalThis as any).__injected;
})
).toBe(undefined);
// By-pass CSP and try one more time.
await page.setBypassCSP(true);
await page.reload();
await page.addScriptTag({content: 'window.__injected = 42;'});
expect(
await page.evaluate(() => {
return (globalThis as any).__injected;
})
).toBe(42);
});
it('should bypass after cross-process navigation', async () => {
const {page, server} = await getTestState();
await page.setBypassCSP(true);
await page.goto(server.PREFIX + '/csp.html');
await page.addScriptTag({content: 'window.__injected = 42;'});
expect(
await page.evaluate(() => {
return (globalThis as any).__injected;
})
).toBe(42);
await page.goto(server.CROSS_PROCESS_PREFIX + '/csp.html');
await page.addScriptTag({content: 'window.__injected = 42;'});
expect(
await page.evaluate(() => {
return (globalThis as any).__injected;
})
).toBe(42);
});
it('should bypass CSP in iframes as well', async () => {
const {page, server} = await getTestState();
await page.goto(server.EMPTY_PAGE);
{
// Make sure CSP prohibits addScriptTag in an iframe.
const frame = (await attachFrame(
page,
'frame1',
server.PREFIX + '/csp.html'
))!;
await frame
.addScriptTag({content: 'window.__injected = 42;'})
.catch(error => {
return void error;
});
expect(
await frame.evaluate(() => {
return (globalThis as any).__injected;
})
).toBe(undefined);
}
// By-pass CSP and try one more time.
await page.setBypassCSP(true);
await page.reload();
{
const frame = (await attachFrame(
page,
'frame1',
server.PREFIX + '/csp.html'
))!;
await frame
.addScriptTag({content: 'window.__injected = 42;'})
.catch(error => {
return void error;
});
expect(
await frame.evaluate(() => {
return (globalThis as any).__injected;
})
).toBe(42);
}
});
});
describe('Page.addScriptTag', function () {
it('should throw an error if no options are provided', async () => {
const {page} = await getTestState();
let error!: Error;
try {
// @ts-expect-error purposefully passing bad options
await page.addScriptTag('/injectedfile.js');
} catch (error_) {
error = error_ as Error;
}
expect(error.message).toBe(
'Exactly one of `url`, `path`, or `content` must be specified.'
);
});
it('should work with a url', async () => {
const {page, server} = await getTestState();
await page.goto(server.EMPTY_PAGE);
using scriptHandle = await page.addScriptTag({url: '/injectedfile.js'});
expect(scriptHandle.asElement()).not.toBeNull();
expect(
await page.evaluate(() => {
return (globalThis as any).__injected;
})
).toBe(42);
});
it('should work with a url and type=module', async () => {
const {page, server} = await getTestState();
await page.goto(server.EMPTY_PAGE);
await page.addScriptTag({url: '/es6/es6import.js', type: 'module'});
expect(
await page.evaluate(() => {
return (window as unknown as {__es6injected: number}).__es6injected;
})
).toBe(42);
});
it('should work with a path and type=module', async () => {
const {page, server} = await getTestState();
await page.goto(server.EMPTY_PAGE);
await page.addScriptTag({
path: path.join(__dirname, '../assets/es6/es6pathimport.js'),
type: 'module',
});
await page.waitForFunction(() => {
return (window as unknown as {__es6injected: number}).__es6injected;
});
expect(
await page.evaluate(() => {
return (window as unknown as {__es6injected: number}).__es6injected;
})
).toBe(42);
});
it('should work with a content and type=module', async () => {
const {page, server} = await getTestState();
await page.goto(server.EMPTY_PAGE);
await page.addScriptTag({
content: `import num from '/es6/es6module.js';window.__es6injected = num;`,
type: 'module',
});
await page.waitForFunction(() => {
return (window as unknown as {__es6injected: number}).__es6injected;
});
expect(
await page.evaluate(() => {
return (window as unknown as {__es6injected: number}).__es6injected;
})
).toBe(42);
});
it('should throw an error if loading from url fail', async () => {
const {page, server, isFirefox} = await getTestState();
await page.goto(server.EMPTY_PAGE);
let error!: Error;
try {
await page.addScriptTag({url: '/nonexistfile.js'});
} catch (error_) {
error = error_ as Error;
}
if (isFirefox) {
expect(error.message).toBeTruthy();
} else {
expect(error.message).toContain('Could not load script');
}
});
it('should work with a path', async () => {
const {page, server} = await getTestState();
await page.goto(server.EMPTY_PAGE);
using scriptHandle = await page.addScriptTag({
path: path.join(__dirname, '../assets/injectedfile.js'),
});
expect(scriptHandle.asElement()).not.toBeNull();
expect(
await page.evaluate(() => {
return (globalThis as any).__injected;
})
).toBe(42);
});
it('should include sourcemap when path is provided', async () => {
const {page, server} = await getTestState();
await page.goto(server.EMPTY_PAGE);
await page.addScriptTag({
path: path.join(__dirname, '../assets/injectedfile.js'),
});
const result = await page.evaluate(() => {
return (globalThis as any).__injectedError.stack;
});
expect(result).toContain(path.join('assets', 'injectedfile.js'));
});
it('should work with content', async () => {
const {page, server} = await getTestState();
await page.goto(server.EMPTY_PAGE);
using scriptHandle = await page.addScriptTag({
content: 'window.__injected = 35;',
});
expect(scriptHandle.asElement()).not.toBeNull();
expect(
await page.evaluate(() => {
return (globalThis as any).__injected;
})
).toBe(35);
});
it('should add id when provided', async () => {
const {page, server} = await getTestState();
await page.goto(server.EMPTY_PAGE);
await page.addScriptTag({content: 'window.__injected = 1;', id: 'one'});
await page.addScriptTag({url: '/injectedfile.js', id: 'two'});
expect(await page.$('#one')).not.toBeNull();
expect(await page.$('#two')).not.toBeNull();
});
it('should throw when added with content to the CSP page', async () => {
const {page, server} = await getTestState();
await page.goto(server.PREFIX + '/csp.html');
let error!: Error;
await page
.addScriptTag({content: 'window.__injected = 35;'})
.catch(error_ => {
return (error = error_);
});
expect(error).toBeTruthy();
});
it('should throw when added with URL to the CSP page', async () => {
const {page, server} = await getTestState();
await page.goto(server.PREFIX + '/csp.html');
let error!: Error;
await page
.addScriptTag({url: server.CROSS_PROCESS_PREFIX + '/injectedfile.js'})
.catch(error_ => {
return (error = error_);
});
expect(error).toBeTruthy();
});
});
describe('Page.addStyleTag', function () {
it('should throw an error if no options are provided', async () => {
const {page} = await getTestState();
let error!: Error;
try {
// @ts-expect-error purposefully passing bad input
await page.addStyleTag('/injectedstyle.css');
} catch (error_) {
error = error_ as Error;
}
expect(error.message).toBe(
'Exactly one of `url`, `path`, or `content` must be specified.'
);
});
it('should work with a url', async () => {
const {page, server} = await getTestState();
await page.goto(server.EMPTY_PAGE);
using styleHandle = await page.addStyleTag({url: '/injectedstyle.css'});
expect(styleHandle.asElement()).not.toBeNull();
expect(
await page.evaluate(
`window.getComputedStyle(document.querySelector('body')).getPropertyValue('background-color')`
)
).toBe('rgb(255, 0, 0)');
});
it('should throw an error if loading from url fail', async () => {
const {page, server, isFirefox} = await getTestState();
await page.goto(server.EMPTY_PAGE);
let error!: Error;
try {
await page.addStyleTag({url: '/nonexistfile.js'});
} catch (error_) {
error = error_ as Error;
}
if (isFirefox) {
expect(error.message).toBeTruthy();
} else {
expect(error.message).toContain('Could not load style');
}
});
it('should work with a path', async () => {
const {page, server} = await getTestState();
await page.goto(server.EMPTY_PAGE);
using styleHandle = await page.addStyleTag({
path: path.join(__dirname, '../assets/injectedstyle.css'),
});
expect(styleHandle.asElement()).not.toBeNull();
expect(
await page.evaluate(
`window.getComputedStyle(document.querySelector('body')).getPropertyValue('background-color')`
)
).toBe('rgb(255, 0, 0)');
});
it('should include sourcemap when path is provided', async () => {
const {page, server} = await getTestState();
await page.goto(server.EMPTY_PAGE);
await page.addStyleTag({
path: path.join(__dirname, '../assets/injectedstyle.css'),
});
using styleHandle = (await page.$('style'))!;
const styleContent = await page.evaluate((style: HTMLStyleElement) => {
return style.innerHTML;
}, styleHandle);
expect(styleContent).toContain(path.join('assets', 'injectedstyle.css'));
});
it('should work with content', async () => {
const {page, server} = await getTestState();
await page.goto(server.EMPTY_PAGE);
using styleHandle = await page.addStyleTag({
content: 'body { background-color: green; }',
});
expect(styleHandle.asElement()).not.toBeNull();
expect(
await page.evaluate(
`window.getComputedStyle(document.querySelector('body')).getPropertyValue('background-color')`
)
).toBe('rgb(0, 128, 0)');
});
it('should throw when added with content to the CSP page', async () => {
const {page, server} = await getTestState();
await page.goto(server.PREFIX + '/csp.html');
let error!: Error;
await page
.addStyleTag({content: 'body { background-color: green; }'})
.catch(error_ => {
return (error = error_);
});
expect(error).toBeTruthy();
});
it('should throw when added with URL to the CSP page', async () => {
const {page, server} = await getTestState();
await page.goto(server.PREFIX + '/csp.html');
let error!: Error;
await page
.addStyleTag({
url: server.CROSS_PROCESS_PREFIX + '/injectedstyle.css',
})
.catch(error_ => {
return (error = error_);
});
expect(error).toBeTruthy();
});
});
describe('Page.url', function () {
it('should work', async () => {
const {page, server} = await getTestState();
expect(page.url()).toBe('about:blank');
await page.goto(server.EMPTY_PAGE);
expect(page.url()).toBe(server.EMPTY_PAGE);
});
});
describe('Page.setJavaScriptEnabled', function () {
it('should work', async () => {
const {page} = await getTestState();
await page.setJavaScriptEnabled(false);
await page.goto(
'data:text/html, <script>var something = "forbidden"</script>'
);
let error!: Error;
await page.evaluate('something').catch(error_ => {
return (error = error_);
});
expect(error.message).toContain('something is not defined');
await page.setJavaScriptEnabled(true);
await page.goto(
'data:text/html, <script>var something = "forbidden"</script>'
);
expect(await page.evaluate('something')).toBe('forbidden');
});
});
describe('Page.setCacheEnabled', function () {
it('should enable or disable the cache based on the state passed', async () => {
const {page, server} = await getTestState();
await page.goto(server.PREFIX + '/cached/one-style.html');
const [cachedRequest] = await Promise.all([
server.waitForRequest('/cached/one-style.html'),
page.reload(),
]);
// Rely on "if-modified-since" caching in our test server.
expect(cachedRequest.headers['if-modified-since']).not.toBe(undefined);
await page.setCacheEnabled(false);
const [nonCachedRequest] = await Promise.all([
server.waitForRequest('/cached/one-style.html'),
page.reload(),
]);
expect(nonCachedRequest.headers['if-modified-since']).toBe(undefined);
});
it('should stay disabled when toggling request interception on/off', async () => {
const {page, server} = await getTestState();
await page.setCacheEnabled(false);
await page.setRequestInterception(true);
await page.setRequestInterception(false);
await page.goto(server.PREFIX + '/cached/one-style.html');
const [nonCachedRequest] = await Promise.all([
server.waitForRequest('/cached/one-style.html'),
page.reload(),
]);
expect(nonCachedRequest.headers['if-modified-since']).toBe(undefined);
});
});
describe('Page.pdf', function () {
it('can print to PDF and save to file', async () => {
const {page, server} = await getTestState();
const outputFile = __dirname + '/../assets/output.pdf';
await page.goto(server.PREFIX + '/pdf.html');
await page.pdf({path: outputFile});
try {
expect(fs.readFileSync(outputFile).byteLength).toBeGreaterThan(0);
} finally {
fs.unlinkSync(outputFile);
}
});
it('can print to PDF and stream the result', async () => {
const {page} = await getTestState();
const stream = await page.createPDFStream();
let size = 0;
const reader = stream.getReader();
while (true) {
const {done, value} = await reader.read();
if (done) {
break;
}
size += value.length;
}
expect(size).toBeGreaterThan(0);
});
it('should respect timeout', async () => {
const {page, server} = await getTestState();
await page.goto(server.PREFIX + '/pdf.html');
const error = await page.pdf({timeout: 1}).catch(err => {
return err;
});
expect(error).toBeInstanceOf(TimeoutError);
});
});
describe('Page.title', function () {
it('should return the page title', async () => {
const {page, server} = await getTestState();
await page.goto(server.PREFIX + '/title.html');
expect(await page.title()).toBe('Woof-Woof');
});
});
describe('Page.select', function () {
it('should select single option', async () => {
const {page, server} = await getTestState();
await page.goto(server.PREFIX + '/input/select.html');
await page.select('select', 'blue');
expect(
await page.evaluate(() => {
return (globalThis as any).result.onInput;
})
).toEqual(['blue']);
expect(
await page.evaluate(() => {
return (globalThis as any).result.onChange;
})
).toEqual(['blue']);
});
it('should select only first option', async () => {
const {page, server} = await getTestState();
await page.goto(server.PREFIX + '/input/select.html');
await page.select('select', 'blue', 'green', 'red');
expect(
await page.evaluate(() => {
return (globalThis as any).result.onInput;
})
).toEqual(['blue']);
expect(
await page.evaluate(() => {
return (globalThis as any).result.onChange;
})
).toEqual(['blue']);
});
it('should not throw when select causes navigation', async () => {
const {page, server} = await getTestState();
await page.goto(server.PREFIX + '/input/select.html');
await page.$eval('select', select => {
return select.addEventListener('input', () => {
return ((window as any).location = '/empty.html');
});
});
await Promise.all([
page.select('select', 'blue'),
page.waitForNavigation(),
]);
expect(page.url()).toContain('empty.html');
});
it('should select multiple options', async () => {
const {page, server} = await getTestState();
await page.goto(server.PREFIX + '/input/select.html');
await page.evaluate(() => {
return (globalThis as any).makeMultiple();
});
await page.select('select', 'blue', 'green', 'red');
expect(
await page.evaluate(() => {
return (globalThis as any).result.onInput;
})
).toEqual(['blue', 'green', 'red']);
expect(
await page.evaluate(() => {
return (globalThis as any).result.onChange;
})
).toEqual(['blue', 'green', 'red']);
});
it('should respect event bubbling', async () => {
const {page, server} = await getTestState();
await page.goto(server.PREFIX + '/input/select.html');
await page.select('select', 'blue');
expect(
await page.evaluate(() => {
return (globalThis as any).result.onBubblingInput;
})
).toEqual(['blue']);
expect(
await page.evaluate(() => {
return (globalThis as any).result.onBubblingChange;
})
).toEqual(['blue']);
});
it('should throw when element is not a <select>', async () => {
const {page, server} = await getTestState();
let error!: Error;
await page.goto(server.PREFIX + '/input/select.html');
await page.select('body', '').catch(error_ => {
return (error = error_);
});
expect(error.message).toContain('Element is not a <select> element.');
});
it('should return [] on no matched values', async () => {
const {page, server} = await getTestState();
await page.goto(server.PREFIX + '/input/select.html');
const result = await page.select('select', '42', 'abc');
expect(result).toEqual([]);
});
it('should return an array of matched values', async () => {
const {page, server} = await getTestState();
await page.goto(server.PREFIX + '/input/select.html');
await page.evaluate(() => {
return (globalThis as any).makeMultiple();
});
const result = await page.select('select', 'blue', 'black', 'magenta');
expect(
result.reduce((accumulator, current) => {
return ['blue', 'black', 'magenta'].includes(current) && accumulator;
}, true)
).toEqual(true);
});
it('should return an array of one element when multiple is not set', async () => {
const {page, server} = await getTestState();
await page.goto(server.PREFIX + '/input/select.html');
const result = await page.select(
'select',
'42',
'blue',
'black',
'magenta'
);
expect(result).toHaveLength(1);
});
it('should return [] on no values', async () => {
const {page, server} = await getTestState();
await page.goto(server.PREFIX + '/input/select.html');
const result = await page.select('select');
expect(result).toEqual([]);
});
it('should deselect all options when passed no values for a multiple select', async () => {
const {page, server} = await getTestState();
await page.goto(server.PREFIX + '/input/select.html');
await page.evaluate(() => {
return (globalThis as any).makeMultiple();
});
await page.select('select', 'blue', 'black', 'magenta');
await page.select('select');
expect(
await page.$eval('select', select => {
return Array.from((select as HTMLSelectElement).options).every(
option => {
return !option.selected;
}
);
})
).toEqual(true);
});
it('should deselect all options when passed no values for a select without multiple', async () => {
const {page, server} = await getTestState();
await page.goto(server.PREFIX + '/input/select.html');
await page.select('select', 'blue', 'black', 'magenta');
await page.select('select');
expect(
await page.$eval('select', select => {
return Array.from((select as HTMLSelectElement).options).filter(
option => {
return option.selected;
}
)[0]!.value;
})
).toEqual('');
});
it('should throw if passed in non-strings', async () => {
const {page} = await getTestState();
await page.setContent('<select><option value="12"/></select>');
let error!: Error;
try {
// @ts-expect-error purposefully passing bad input
await page.select('select', 12);
} catch (error_) {
error = error_ as Error;
}
expect(error.message).toContain('Values must be strings');
});
it('should work when re-defining top-level Event class', async () => {
const {page, server} = await getTestState();
await page.goto(server.PREFIX + '/input/select.html');
await page.evaluate(() => {
// @ts-expect-error Expected.
return (window.Event = undefined);
});
await page.select('select', 'blue');
expect(
await page.evaluate(() => {
return (globalThis as any).result.onInput;
})
).toEqual(['blue']);
expect(
await page.evaluate(() => {
return (globalThis as any).result.onChange;
})
).toEqual(['blue']);
});
});
describe('Page.Events.Close', function () {
it('should work with window.close', async () => {
const {page, context} = await getTestState();
const newPagePromise = new Promise<Page | null>(fulfill => {
return context.once('targetcreated', target => {
return fulfill(target.page());
});
});
assert(page);
await page.evaluate(() => {
return ((window as any)['newPage'] = window.open('about:blank'));
});
const newPage = await newPagePromise;
assert(newPage);
const closedPromise = waitEvent(newPage, 'close');
await page.evaluate(() => {
return (window as any)['newPage'].close();
});
await closedPromise;
});
it('should work with page.close', async () => {
const {context} = await getTestState();
const newPage = await context.newPage();
const closedPromise = waitEvent(newPage, 'close');
await newPage.close();
await closedPromise;
});
});
describe('Page.browser', function () {
it('should return the correct browser instance', async () => {
const {page, browser} = await getTestState();
expect(page.browser()).toBe(browser);
});
});
describe('Page.browserContext', function () {
it('should return the correct browser context instance', async () => {
const {page, context} = await getTestState();
expect(page.browserContext()).toBe(context);
});
});
describe('Page.client', function () {
it('should return the client instance', async () => {
const {page} = await getTestState();
expect((page as CdpPage)._client()).toBeInstanceOf(CDPSession);
});
});
describe('Page.bringToFront', function () {
it('should work', async () => {
const {context} = await getTestState();
const page1 = await context.newPage();
const page2 = await context.newPage();
await page1.bringToFront();
expect(
await page1.evaluate(() => {
return document.visibilityState;
})
).toBe('visible');
expect(
await page2.evaluate(() => {
return document.visibilityState;
})
).toBe('hidden');
await page2.bringToFront();
expect(
await page1.evaluate(() => {
return document.visibilityState;
})
).toBe('hidden');
expect(
await page2.evaluate(() => {
return document.visibilityState;
})
).toBe('visible');
await page1.close();
await page2.close();
});
});
});