thunderstrike/puppeteer
thunderstrike/puppeteer
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore: use a less chatty BiDi+ (#10453)

Browse Source
This commit is contained in:
Nikolay Vitkov 2023-06-28 09:54:16 +02:00 committed by GitHub
parent e452647739
commit ceb6fbb365
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 41 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
package-lock.json generated
View File

@ -3020,9 +3020,9 @@
} }
}, },
"node_modules/chromium-bidi": { "node_modules/chromium-bidi": {
"version": "0.4.13", "version": "0.4.14",
"resolved": "https://registry.npmjs.org/chromium-bidi/-/chromium-bidi-0.4.13.tgz", "resolved": "https://registry.npmjs.org/chromium-bidi/-/chromium-bidi-0.4.14.tgz",
"integrity": "sha512-9m2SY5DHI43OBQ7SMXjwp/iQaYo6iihqJ4IiD1OlrawGQTNveYYeJJt1yCqMxjp5y86m/uHxc9VooOWVlKFi4w==", "integrity": "sha512-79S04G7lLmxbsjIkJaeIWKQQ31ZfzUsfoICWBdjqZnayWnCzBcFAqWhIGu7q85d5LhhauQK5x/gMqIJbV64+DQ==",
"dependencies": { "dependencies": {
"mitt": "3.0.0" "mitt": "3.0.0"
}, },
@ -10109,7 +10109,7 @@
"license": "Apache-2.0", "license": "Apache-2.0",
"dependencies": { "dependencies": {
"@puppeteer/browsers": "1.4.2", "@puppeteer/browsers": "1.4.2",
"chromium-bidi": "0.4.13", "chromium-bidi": "0.4.14",
"cross-fetch": "3.1.6", "cross-fetch": "3.1.6",
"debug": "4.3.4", "debug": "4.3.4",
"devtools-protocol": "0.0.1135028", "devtools-protocol": "0.0.1135028",
@ -12230,9 +12230,9 @@
} }
}, },
"chromium-bidi": { "chromium-bidi": {
"version": "0.4.13", "version": "0.4.14",
"resolved": "https://registry.npmjs.org/chromium-bidi/-/chromium-bidi-0.4.13.tgz", "resolved": "https://registry.npmjs.org/chromium-bidi/-/chromium-bidi-0.4.14.tgz",
"integrity": "sha512-9m2SY5DHI43OBQ7SMXjwp/iQaYo6iihqJ4IiD1OlrawGQTNveYYeJJt1yCqMxjp5y86m/uHxc9VooOWVlKFi4w==", "integrity": "sha512-79S04G7lLmxbsjIkJaeIWKQQ31ZfzUsfoICWBdjqZnayWnCzBcFAqWhIGu7q85d5LhhauQK5x/gMqIJbV64+DQ==",
"requires": { "requires": {
"mitt": "3.0.0" "mitt": "3.0.0"
} }
@ -15653,7 +15653,7 @@
"version": "file:packages/puppeteer-core", "version": "file:packages/puppeteer-core",
"requires": { "requires": {
"@puppeteer/browsers": "1.4.2", "@puppeteer/browsers": "1.4.2",
"chromium-bidi": "0.4.13", "chromium-bidi": "0.4.14",
"cross-fetch": "3.1.6", "cross-fetch": "3.1.6",
"debug": "4.3.4", "debug": "4.3.4",
"devtools-protocol": "0.0.1135028", "devtools-protocol": "0.0.1135028",

2
packages/puppeteer-core/package.json
View File

@ -141,7 +141,7 @@
"author": "The Chromium Authors", "author": "The Chromium Authors",
"license": "Apache-2.0", "license": "Apache-2.0",
"dependencies": { "dependencies": {
"chromium-bidi": "0.4.13", "chromium-bidi": "0.4.14",
"cross-fetch": "3.1.6", "cross-fetch": "3.1.6",
"debug": "4.3.4", "debug": "4.3.4",
"devtools-protocol": "0.0.1135028", "devtools-protocol": "0.0.1135028",

19
packages/puppeteer-core/src/common/bidi/Browser.ts
View File

@ -36,11 +36,18 @@ import {debugError} from './utils.js';
* @internal * @internal
*/ */
export class Browser extends BrowserBase { export class Browser extends BrowserBase {
static readonly subscribeModules = [ static readonly subscribeModules: Bidi.Session.SubscriptionRequestEvent[] = [
'browsingContext', 'browsingContext',
'network', 'network',
'log', 'log',
'cdp', ];
static readonly subscribeCdpEvents: Bidi.CDP.EventNames[] = [
// Coverage
'cdp.Debugger.scriptParsed',
'cdp.CSS.styleSheetAdded',
'cdp.Runtime.executionContextsCleared',
// Tracing
'cdp.Tracing.tracingComplete',
]; ];
#browserName = ''; #browserName = '';
@ -67,11 +74,9 @@ export class Browser extends BrowserBase {
} }
await opts.connection.send('session.subscribe', { await opts.connection.send('session.subscribe', {
events: (browserName.toLocaleLowerCase().includes('firefox') events: browserName.toLocaleLowerCase().includes('firefox')
? Browser.subscribeModules.filter(module => { ? Browser.subscribeModules
return !['cdp'].includes(module); : [...Browser.subscribeModules, ...Browser.subscribeCdpEvents],
})
: Browser.subscribeModules) as Bidi.Message.EventNames[],
}); });
return new Browser({ return new Browser({

10
packages/puppeteer-core/src/common/bidi/BrowsingContext.ts
View File

@ -51,7 +51,7 @@ export class CDPSessionWrapper extends EventEmitter implements CDPSession {
context: context.id, context: context.id,
}) })
.then(session => { .then(session => {
this.#sessionId.resolve(session.result.cdpSession); this.#sessionId.resolve(session.result.session!);
}) })
.catch(err => { .catch(err => {
this.#sessionId.reject(err); this.#sessionId.reject(err);
@ -65,11 +65,11 @@ export class CDPSessionWrapper extends EventEmitter implements CDPSession {
method: T, method: T,
...paramArgs: ProtocolMapping.Commands[T]['paramsType'] ...paramArgs: ProtocolMapping.Commands[T]['paramsType']
): Promise<ProtocolMapping.Commands[T]['returnType']> { ): Promise<ProtocolMapping.Commands[T]['returnType']> {
const cdpSession = await this.#sessionId.valueOrThrow(); const session = await this.#sessionId.valueOrThrow();
const result = await this.#context.connection.send('cdp.sendCommand', { const result = await this.#context.connection.send('cdp.sendCommand', {
cdpMethod: method, method: method,
cdpParams: paramArgs[0] || {}, params: paramArgs[0],
cdpSession, session,
}); });
return result.result; return result.result;
} }

15
packages/puppeteer-core/src/common/bidi/Connection.ts
View File

@ -234,17 +234,14 @@ export class Connection extends EventEmitter {
// `log.entryAdded` specific context // `log.entryAdded` specific context
} else if ('source' in event.params && event.params.source.context) { } else if ('source' in event.params && event.params.source.context) {
context = this.#browsingContexts.get(event.params.source.context); context = this.#browsingContexts.get(event.params.source.context);
} else if (event.method === 'cdp.eventReceived') { } else if (isCDPEvent(event)) {
// TODO: this is not a good solution and we need to find a better one. // TODO: this is not a good solution and we need to find a better one.
// Perhaps we need to have a dedicated CDP event emitter or emulate // Perhaps we need to have a dedicated CDP event emitter or emulate
// the CDPSession interface with BiDi?. // the CDPSession interface with BiDi?.
const cdpSessionId = event.params.cdpSession; const cdpSessionId = event.params.session;
for (const context of this.#browsingContexts.values()) { for (const context of this.#browsingContexts.values()) {
if (context.cdpSession?.id() === cdpSessionId) { if (context.cdpSession?.id() === cdpSessionId) {
context.cdpSession!.emit( context.cdpSession!.emit(event.params.event, event.params.params);
event.params.cdpMethod,
event.params.cdpParams
);
} }
} }
} }
@ -285,3 +282,9 @@ function createProtocolError(object: Bidi.Message.ErrorResult): string {
} }
return message; return message;
} }
function isCDPEvent(
event: Bidi.Message.EventMessage
): event is Bidi.CDP.EventReceivedEvent {
return event.method.startsWith('cdp.');
}

20
test/TestExpectations.json
View File

@ -1739,18 +1739,6 @@
"parameters": ["chrome", "webDriverBiDi"], "parameters": ["chrome", "webDriverBiDi"],
"expectations": ["FAIL"] "expectations": ["FAIL"]
}, },
{
"testIdPattern": "[coverage.spec] Coverage specs JSCoverage includeRawScriptCoverage should include rawScriptCoverage field when enabled",
"platforms": ["darwin", "linux", "win32"],
"parameters": ["chrome", "webDriverBiDi"],
"expectations": ["FAIL"]
},
{
"testIdPattern": "[coverage.spec] Coverage specs JSCoverage includeRawScriptCoverage should not include rawScriptCoverage field when disabled",
"platforms": ["darwin", "linux", "win32"],
"parameters": ["chrome", "webDriverBiDi"],
"expectations": ["FAIL"]
},
{ {
"testIdPattern": "[coverage.spec] Coverage specs JSCoverage should ignore pptr internal scripts if reportAnonymousScripts is true", "testIdPattern": "[coverage.spec] Coverage specs JSCoverage should ignore pptr internal scripts if reportAnonymousScripts is true",
"platforms": ["darwin", "linux", "win32"], "platforms": ["darwin", "linux", "win32"],
@ -1758,13 +1746,7 @@
"expectations": ["FAIL"] "expectations": ["FAIL"]
}, },
{ {
"testIdPattern": "[coverage.spec] Coverage specs JSCoverage should work", "testIdPattern": "[coverage.spec] Coverage specs JSCoverage should not ignore eval() scripts if reportAnonymousScripts is true",
"platforms": ["darwin", "linux", "win32"],
"parameters": ["chrome", "webDriverBiDi"],
"expectations": ["FAIL"]
},
{
"testIdPattern": "[coverage.spec] Coverage specs JSCoverage shouldn't ignore eval() scripts if reportAnonymousScripts is true",
"platforms": ["darwin", "linux", "win32"], "platforms": ["darwin", "linux", "win32"],
"parameters": ["chrome", "webDriverBiDi"], "parameters": ["chrome", "webDriverBiDi"],
"expectations": ["FAIL", "PASS"] "expectations": ["FAIL", "PASS"]

9
test/src/coverage.spec.ts
View File

@ -24,7 +24,7 @@ describe('Coverage specs', function () {
const {page, server} = await getTestState(); const {page, server} = await getTestState();
await page.coverage.startJSCoverage(); await page.coverage.startJSCoverage();
await page.goto(server.PREFIX + '/jscoverage/simple.html', { await page.goto(server.PREFIX + '/jscoverage/simple.html', {
waitUntil: 'networkidle0', waitUntil: 'load',
}); });
const coverage = await page.coverage.stopJSCoverage(); const coverage = await page.coverage.stopJSCoverage();
expect(coverage).toHaveLength(1); expect(coverage).toHaveLength(1);
@ -51,7 +51,7 @@ describe('Coverage specs', function () {
const coverage = await page.coverage.stopJSCoverage(); const coverage = await page.coverage.stopJSCoverage();
expect(coverage).toHaveLength(1); expect(coverage).toHaveLength(1);
}); });
it("shouldn't ignore eval() scripts if reportAnonymousScripts is true", async () => { it('should not ignore eval() scripts if reportAnonymousScripts is true', async () => {
const {page, server} = await getTestState(); const {page, server} = await getTestState();
await page.coverage.startJSCoverage({reportAnonymousScripts: true}); await page.coverage.startJSCoverage({reportAnonymousScripts: true});
@ -183,7 +183,7 @@ describe('Coverage specs', function () {
const {page, server} = await getTestState(); const {page, server} = await getTestState();
await page.coverage.startJSCoverage(); await page.coverage.startJSCoverage();
await page.goto(server.PREFIX + '/jscoverage/simple.html', { await page.goto(server.PREFIX + '/jscoverage/simple.html', {
waitUntil: 'networkidle0', waitUntil: 'load',
}); });
const coverage = await page.coverage.stopJSCoverage(); const coverage = await page.coverage.stopJSCoverage();
expect(coverage).toHaveLength(1); expect(coverage).toHaveLength(1);
@ -195,7 +195,7 @@ describe('Coverage specs', function () {
includeRawScriptCoverage: true, includeRawScriptCoverage: true,
}); });
await page.goto(server.PREFIX + '/jscoverage/simple.html', { await page.goto(server.PREFIX + '/jscoverage/simple.html', {
waitUntil: 'networkidle0', waitUntil: 'load',
}); });
const coverage = await page.coverage.stopJSCoverage(); const coverage = await page.coverage.stopJSCoverage();
expect(coverage).toHaveLength(1); expect(coverage).toHaveLength(1);
@ -269,6 +269,7 @@ describe('Coverage specs', function () {
await page.goto(server.PREFIX + '/csscoverage/media.html'); await page.goto(server.PREFIX + '/csscoverage/media.html');
const coverage = await page.coverage.stopCSSCoverage(); const coverage = await page.coverage.stopCSSCoverage();
expect(coverage).toHaveLength(1); expect(coverage).toHaveLength(1);
console.log(coverage);
expect(coverage[0]!.url).toContain('/csscoverage/media.html'); expect(coverage[0]!.url).toContain('/csscoverage/media.html');
expect(coverage[0]!.ranges).toEqual([{start: 8, end: 40}]); expect(coverage[0]!.ranges).toEqual([{start: 8, end: 40}]);
}); });