Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
TypeScript automationchromechromiume2e-testingelectronend-to-end-testingfirefoxjavascriptplaywrighttesttest-automationtestingtesting-toolswebwebkit
/**
* Copyright 2018 Google Inc. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { kTargetClosedErrorMessage } from '../../config/errors';
import { contextTest as it, expect } from '../../config/browserTest';
import { browserTest } from '../../config/browserTest';
it('CD-037 should work', async function({ page }) {
const client = await page.context().newCDPSession(page);
await Promise.all([
client.send('Runtime.enable'),
client.send('Runtime.evaluate', { expression: 'window.foo = "bar"' })
]);
const foo = await page.evaluate(() => window['foo']);
expect(foo).toBe('bar');
});
it('CD-038 should respect timeout and signal options', async function({ page, playwright }) {
const client = await page.context().newCDPSession(page);
const evalResponse = await client.send('Runtime.evaluate', { expression: '1 + 2', returnByValue: true }, { timeout: 5000 });
expect(evalResponse.result.value).toBe(3);
const error = await client.send('Runtime.evaluate', { expression: 'new Promise(() => {})', awaitPromise: true }, { timeout: 500 }).catch(e => e);
expect(error).toBeInstanceOf(playwright.errors.TimeoutError);
expect(error.message).toContain('Timeout 500ms exceeded');
const controller = new AbortController();
const promise = client.send('Runtime.evaluate', { expression: 'new Promise(() => {})', awaitPromise: true }, { signal: controller.signal }).catch(e => e);
const reason = new Error('Aborted by user');
controller.abort(reason);
const abortError = await promise;
expect(abortError.name).toBe('AbortError');
expect(abortError.cause).toBe(reason);
});
it('CD-039 should send events', async function({ page, server }) {
const client = await page.context().newCDPSession(page);
await client.send('Network.enable');
const events = [];
client.on('Network.requestWillBeSent', event => events.push(event));
await page.goto(server.EMPTY_PAGE);
expect(events.length).toBe(1);
});
it('CD-040 should only accept a page or frame', async function({ page }) {
// @ts-expect-error newCDPSession expects a Page or Frame
const error = await page.context().newCDPSession(page.context()).catch(e => e);
expect(error.message).toContain('page: expected Page or Frame');
// non-channelable types hit validation at a different layer
// @ts-expect-error newCDPSession expects a Page or Frame
const errorAlt = await page.context().newCDPSession({}).catch(e => e);
expect(errorAlt.message).toContain('page: expected Page or Frame');
});
it('CD-041 should enable and disable domains independently', async function({ page }) {
const client = await page.context().newCDPSession(page);
await client.send('Runtime.enable');
await client.send('Debugger.enable');
// JS coverage enables and then disables Debugger domain.
await page.coverage.startJSCoverage();
await page.coverage.stopJSCoverage();
// generate a script in page and wait for the event.
await Promise.all([
new Promise<void>(f => client.on('Debugger.scriptParsed', event => {
if (event.url === 'foo.js')
f();
})),
page.evaluate('//# sourceURL=foo.js')
]);
});
it('CD-042 should be able to detach session', async function({ page }) {
const client = await page.context().newCDPSession(page);
await client.send('Runtime.enable');
const evalResponse = await client.send('Runtime.evaluate', { expression: '1 + 2', returnByValue: true });
expect(evalResponse.result.value).toBe(3);
await client.detach();
let error = null;
try {
await client.send('Runtime.evaluate', { expression: '3 + 1', returnByValue: true });
} catch (e) {
error = e;
}
expect(error.message).toContain('Target page, context or browser has been closed');
});
it('CD-043 should throw nice errors', async function({ page }) {
const client = await page.context().newCDPSession(page);
const error = await theSourceOfTheProblems().catch(error => error);
expect(error.stack).toContain('theSourceOfTheProblems');
expect(error.message).toContain('ThisCommand.DoesNotExist');
async function theSourceOfTheProblems() {
// @ts-expect-error invalid command
await client.send('ThisCommand.DoesNotExist');
}
});
it('CD-044 should work with main frame', async function({ page }) {
const client = await page.context().newCDPSession(page.mainFrame());
await Promise.all([
client.send('Runtime.enable'),
client.send('Runtime.evaluate', { expression: 'window.foo = "bar"' })
]);
const foo = await page.evaluate(() => window['foo']);
expect(foo).toBe('bar');
});
it('CD-045 should throw if target is part of main', async function({ server, page }){
await page.goto(server.PREFIX + '/frames/one-frame.html');
expect(page.frames()[0].url()).toContain('/frames/one-frame.html');
expect(page.frames()[1].url()).toContain('/frames/frame.html');
const error = await page.context().newCDPSession(page.frames()[1]).catch(e => e);
expect(error.message).toContain(`This frame does not have a separate CDP session, it is a part of the parent frame's session`);
});
browserTest('CD-046 should not break page.close()', async function({ browser }) {
const context = await browser.newContext();
const page = await context.newPage();
const session = await page.context().newCDPSession(page);
await session.detach();
await page.close();
await context.close();
});
browserTest('CD-047 should detach when page closes', async function({ browser }) {
const context = await browser.newContext();
const page = await context.newPage();
const session = await context.newCDPSession(page);
await page.close();
let error;
await session.detach().catch(e => error = e);
expect(error).toBeTruthy();
await context.close();
});
browserTest('CD-048 should reject protocol calls when page closes', async function({ browser }) {
const context = await browser.newContext();
const page = await context.newPage();
const session = await context.newCDPSession(page);
const promise = session.send('Runtime.evaluate', { expression: 'new Promise(() => {})', awaitPromise: true }).catch(e => e);
await page.close();
const error1 = await promise;
expect(error1.message).toContain(kTargetClosedErrorMessage);
const error2 = await session.send('Runtime.evaluate', { expression: 'new Promise(() => {})', awaitPromise: true }).catch(e => e);
expect(error2.message).toContain('Target page, context or browser has been closed');
await context.close();
});
it('CD-049 should emit event for each CDP event', async function({ page, server }) {
const client = await page.context().newCDPSession(page);
await client.send('Network.enable');
const events = [];
client.on('event', event => events.push(event));
await page.goto(server.EMPTY_PAGE);
expect(events.length).toBeGreaterThan(0);
const requestEvent = events.find(e => e.method === 'Network.requestWillBeSent');
expect(requestEvent).toBeTruthy();
expect(requestEvent.params.request.url).toBe(server.EMPTY_PAGE);
});
it('CD-050 should emit close event when session is detached', async function({ page }) {
const client = await page.context().newCDPSession(page);
let closedSession: any = null;
client.on('close', session => closedSession = session);
await client.detach();
expect(closedSession).toBe(client);
});
browserTest('CD-051 should emit close event when page closes', async function({ browser }) {
const context = await browser.newContext();
const page = await context.newPage();
const session = await context.newCDPSession(page);
const closePromise = new Promise(f => session.on('close', f));
await page.close();
const closedSession = await closePromise;
expect(closedSession).toBe(session);
await context.close();
});
browserTest('CD-052 should work with newBrowserCDPSession', async function({ browser }) {
const session = await browser.newBrowserCDPSession();
const version = await session.send('Browser.getVersion');
expect(version.userAgent).toBeTruthy();
let gotEvent = false;
session.on('Target.targetCreated', () => gotEvent = true);
await session.send('Target.setDiscoverTargets', { discover: true });
const page = await browser.newPage();
expect(gotEvent).toBe(true);
await page.close();
await session.detach();
});