yujunjun/playwright
1
0
Fork 0
mirror of https://github.com/microsoft/playwright.git synced 2025-06-26 21:40:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

api(cdp): rename createSession to newCDPSession (#1378)

Browse Source
This commit is contained in:
Pavel Feldman 2020-03-13 09:00:03 -07:00 committed by GitHub
parent b1a3b23c38
commit 8aba111f1e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/api.md
View File

@ -3721,7 +3721,7 @@ await browser.stopTracing();
```
<!-- GEN:toc -->
- [chromiumBrowser.createBrowserSession()](#chromiumbrowsercreatebrowsersession)
- [chromiumBrowser.newBrowserCDPSession()](#chromiumbrowsernewbrowsercdpsession)
- [chromiumBrowser.startTracing([page, options])](#chromiumbrowserstarttracingpage-options)
- [chromiumBrowser.stopTracing()](#chromiumbrowserstoptracing)
<!-- GEN:stop -->
@ -3734,7 +3734,7 @@ await browser.stopTracing();
- [browser.newPage([options])](#browsernewpageoptions)
<!-- GEN:stop -->
#### chromiumBrowser.createBrowserSession()
#### chromiumBrowser.newBrowserCDPSession()
- returns: <[Promise]<[ChromiumSession]>> Promise that resolves to the newly created browser
session.
@ -3766,7 +3766,7 @@ const backgroundPage = await backroundPageTarget.page();
- [event: 'backgroundpage'](#event-backgroundpage)
- [event: 'serviceworker'](#event-serviceworker)
- [chromiumBrowserContext.backgroundPages()](#chromiumbrowsercontextbackgroundpages)
- [chromiumBrowserContext.createSession(page)](#chromiumbrowsercontextcreatesessionpage)
- [chromiumBrowserContext.newCDPSession(page)](#chromiumbrowsercontextnewcdpsessionpage)
<!-- GEN:stop -->
<!-- GEN:toc-extends-BrowserContext -->
- [event: 'close'](#event-close)
@ -3806,7 +3806,7 @@ Emitted when new service worker is created in the context.
#### chromiumBrowserContext.backgroundPages()
- returns: <[Promise]<[Array]<[Page]>>> Promise which resolves to an array of all existing background pages in the context.
#### chromiumBrowserContext.createSession(page)
#### chromiumBrowserContext.newCDPSession(page)
- `page` <[Page]> Page to create new session for.
- returns: <[Promise]<[ChromiumSession]>> Promise that resolves to the newly created session.
@ -3888,7 +3888,7 @@ Useful links:
- Getting Started with DevTools Protocol: https://github.com/aslushnikov/getting-started-with-cdp/blob/master/README.md
```js
const client = await page.context().createSession(page);
const client = await page.context().newCDPSession(page);
await client.send('Animation.enable');
client.on('Animation.animationCreated', () => console.log('Animation created!'));
const response = await client.send('Animation.getPlaybackRate');

4
src/chromium/crBrowser.ts
View File

@ -187,7 +187,7 @@ export class CRBrowser extends platform.EventEmitter implements Browser {
await disconnected;
}
async createBrowserSession(): Promise<CRSession> {
async newBrowserCDPSession(): Promise<CRSession> {
return await this._connection.createBrowserSession();
}
@ -419,7 +419,7 @@ export class CRBrowserContext extends BrowserContextBase {
return pages.filter(page => (page instanceof Page) && !page.isClosed()) as Page[];
}
async createSession(page: Page): Promise<CRSession> {
async newCDPSession(page: Page): Promise<CRSession> {
const targetId = CRTarget.fromPage(page)._targetId;
const rootSession = await this._browser._clientRootSession();
const { sessionId } = await rootSession.send('Target.attachToTarget', { targetId, flatten: true });

4
test/chromium/launcher.spec.js
View File

@ -62,7 +62,7 @@ module.exports.describe = function({testRunner, expect, defaultBrowserOptions, b
it('should open devtools when "devtools: true" option is given', async({server}) => {
const browser = await browserType.launch(Object.assign({devtools: true}, headfulOptions));
const context = await browser.newContext();
const browserSession = await browser.createBrowserSession();
const browserSession = await browser.newBrowserCDPSession();
await browserSession.send('Target.setDiscoverTargets', { discover: true });
const devtoolsPagePromise = new Promise(fulfill => browserSession.on('Target.targetCreated', async ({targetInfo}) => {
if (targetInfo.type === 'other' && targetInfo.url.includes('devtools://'))
@ -124,7 +124,7 @@ module.exports.describe = function({testRunner, expect, defaultBrowserOptions, b
describe('BrowserContext', function() {
it('should not create pages automatically', async function() {
const browser = await browserType.launch();
const browserSession = await browser.createBrowserSession();
const browserSession = await browser.newBrowserCDPSession();
const targets = [];
browserSession.on('Target.targetCreated', async ({targetInfo}) => {
if (targetInfo.type !== 'browser')

2
test/chromium/oopif.spec.js
View File

@ -89,7 +89,7 @@ module.exports.describe = function({testRunner, expect, defaultBrowserOptions, b
};
async function countOOPIFs(browser) {
const browserSession = await browser.createBrowserSession();
const browserSession = await browser.newBrowserCDPSession();
const oopifs = [];
browserSession.on('Target.targetCreated', async ({targetInfo}) => {
if (targetInfo.type === 'iframe')

18
test/chromium/session.spec.js
View File

@ -26,7 +26,7 @@ module.exports.describe = function({testRunner, expect, FFOX, CHROMIUM, WEBKIT})
describe('ChromiumBrowserContext.createSession', function() {
it('should work', async function({page, browser, server}) {
const client = await page.context().createSession(page);
const client = await page.context().newCDPSession(page);
await Promise.all([
client.send('Runtime.enable'),
@ -36,7 +36,7 @@ module.exports.describe = function({testRunner, expect, FFOX, CHROMIUM, WEBKIT})
expect(foo).toBe('bar');
});
it('should send events', async function({page, browser, server}) {
const client = await page.context().createSession(page);
const client = await page.context().newCDPSession(page);
await client.send('Network.enable');
const events = [];
client.on('Network.requestWillBeSent', event => events.push(event));
@ -44,7 +44,7 @@ module.exports.describe = function({testRunner, expect, FFOX, CHROMIUM, WEBKIT})
expect(events.length).toBe(1);
});
it('should enable and disable domains independently', async function({page, browser, server}) {
const client = await page.context().createSession(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.
@ -59,7 +59,7 @@ module.exports.describe = function({testRunner, expect, FFOX, CHROMIUM, WEBKIT})
expect(event.url).toBe('foo.js');
});
it('should be able to detach session', async function({page, browser, server}) {
const client = await page.context().createSession(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);
@ -73,7 +73,7 @@ module.exports.describe = function({testRunner, expect, FFOX, CHROMIUM, WEBKIT})
expect(error.message).toContain('Session closed.');
});
it('should throw nice errors', async function({page, browser}) {
const client = await page.context().createSession(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');
@ -85,7 +85,7 @@ module.exports.describe = function({testRunner, expect, FFOX, CHROMIUM, WEBKIT})
it('should not break page.close()', async function({browser, server}) {
const context = await browser.newContext();
const page = await context.newPage();
const session = await page.context().createSession(page);
const session = await page.context().newCDPSession(page);
await session.detach();
await page.close();
await context.close();
@ -93,7 +93,7 @@ module.exports.describe = function({testRunner, expect, FFOX, CHROMIUM, WEBKIT})
it('should detach when page closes', async function({browser, server}) {
const context = await browser.newContext();
const page = await context.newPage();
const session = await context.createSession(page);
const session = await context.newCDPSession(page);
await page.close();
let error;
await session.detach().catch(e => error = e);
@ -101,9 +101,9 @@ module.exports.describe = function({testRunner, expect, FFOX, CHROMIUM, WEBKIT})
await context.close();
});
});
describe('ChromiumBrowser.createBrowserSession', function() {
describe('ChromiumBrowser.newBrowserCDPSession', function() {
it('should work', async function({page, browser, server}) {
const session = await browser.createBrowserSession();
const session = await browser.newBrowserCDPSession();
const version = await session.send('Browser.getVersion');
expect(version.userAgent).toBeTruthy();
await session.detach();