Skip to content

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.

chore(cdp): event name -> method (#39570)

Yury Semikhatsky23b12474a184
diff --git a/docs/src/api/class-cdpsession.md b/docs/src/api/class-cdpsession.md
index 8efa8e1da7..6573d63860 100644
--- a/docs/src/api/class-cdpsession.md
+++ b/docs/src/api/class-cdpsession.md
@@ -77,7 +77,7 @@ Emitted when the session is closed, either because the target was closed or `ses
* since: v1.59
* langs: js
- argument: <[Object]>
- - `name` <[string]> CDP event name.
+ - `method` <[string]> CDP event name.
- `params` ?<[Object]> CDP event parameters.
Emitted for every CDP event received from the session. Allows subscribing to all CDP events at once without knowing
diff --git a/packages/playwright-client/types/types.d.ts b/packages/playwright-client/types/types.d.ts
index 2048ef3665..c7b0375a83 100644
--- a/packages/playwright-client/types/types.d.ts
+++ b/packages/playwright-client/types/types.d.ts
@@ -16058,7 +16058,7 @@ export interface CDPSession {
/**
* CDP event name.
*/
- name: string;
+ method: string;
/**
* CDP event parameters.
@@ -16078,7 +16078,7 @@ export interface CDPSession {
/**
* CDP event name.
*/
- name: string;
+ method: string;
/**
* CDP event parameters.
@@ -16108,7 +16108,7 @@ export interface CDPSession {
/**
* CDP event name.
*/
- name: string;
+ method: string;
/**
* CDP event parameters.
@@ -16128,7 +16128,7 @@ export interface CDPSession {
/**
* CDP event name.
*/
- name: string;
+ method: string;
/**
* CDP event parameters.
@@ -16148,7 +16148,7 @@ export interface CDPSession {
/**
* CDP event name.
*/
- name: string;
+ method: string;
/**
* CDP event parameters.
@@ -16178,7 +16178,7 @@ export interface CDPSession {
/**
* CDP event name.
*/
- name: string;
+ method: string;
/**
* CDP event parameters.
diff --git a/packages/playwright-core/src/client/cdpSession.ts b/packages/playwright-core/src/client/cdpSession.ts
index 25f374af79..cb0553a3ad 100644
--- a/packages/playwright-core/src/client/cdpSession.ts
+++ b/packages/playwright-core/src/client/cdpSession.ts
@@ -28,9 +28,9 @@ export class CDPSession extends ChannelOwner<channels.CDPSessionChannel> impleme
constructor(parent: ChannelOwner, type: string, guid: string, initializer: channels.CDPSessionInitializer) {
super(parent, type, guid, initializer);
- this._channel.on('event', ({ method, params }) => {
- this.emit(method, params);
- this.emit('event', { name: method, params });
+ this._channel.on('event', event => {
+ this.emit(event.method, event.params);
+ this.emit('event', event);
});
this._channel.on('close', () => {
diff --git a/packages/playwright-core/types/types.d.ts b/packages/playwright-core/types/types.d.ts
index 2048ef3665..c7b0375a83 100644
--- a/packages/playwright-core/types/types.d.ts
+++ b/packages/playwright-core/types/types.d.ts
@@ -16058,7 +16058,7 @@ export interface CDPSession {
/**
* CDP event name.
*/
- name: string;
+ method: string;
/**
* CDP event parameters.
@@ -16078,7 +16078,7 @@ export interface CDPSession {
/**
* CDP event name.
*/
- name: string;
+ method: string;
/**
* CDP event parameters.
@@ -16108,7 +16108,7 @@ export interface CDPSession {
/**
* CDP event name.
*/
- name: string;
+ method: string;
/**
* CDP event parameters.
@@ -16128,7 +16128,7 @@ export interface CDPSession {
/**
* CDP event name.
*/
- name: string;
+ method: string;
/**
* CDP event parameters.
@@ -16148,7 +16148,7 @@ export interface CDPSession {
/**
* CDP event name.
*/
- name: string;
+ method: string;
/**
* CDP event parameters.
@@ -16178,7 +16178,7 @@ export interface CDPSession {
/**
* CDP event name.
*/
- name: string;
+ method: string;
/**
* CDP event parameters.
diff --git a/tests/library/chromium/session.spec.ts b/tests/library/chromium/session.spec.ts
index 5e7789b7bd..830a057514 100644
--- a/tests/library/chromium/session.spec.ts
+++ b/tests/library/chromium/session.spec.ts
@@ -153,7 +153,7 @@ it('should emit event for each CDP event', async function({ page, server }) {
client.on('event', event => events.push(event));
await page.goto(server.EMPTY_PAGE);
expect(events.length).toBeGreaterThan(0);
- const requestEvent = events.find(e => e.name === 'Network.requestWillBeSent');
+ const requestEvent = events.find(e => e.method === 'Network.requestWillBeSent');
expect(requestEvent).toBeTruthy();
expect(requestEvent.params.request.url).toBe(server.EMPTY_PAGE);
});