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
chore: introduce typed devtools channel (#39250)
Pavel Feldmanc4a698f1bd02
diff --git a/packages/devtools/src/devtools.tsx b/packages/devtools/src/devtools.tsxindex dbbbf92580..f4f8719400 100644--- a/packages/devtools/src/devtools.tsx+++ b/packages/devtools/src/devtools.tsx@@ -17,9 +17,10 @@import React from 'react';import './devtools.css';import { navigate } from './index';-import { DevToolsTransport } from './transport';+import { DevToolsClient } from './devtoolsClient';-type TabInfo = { id: string; title: string; url: string };+import type { DevToolsClientChannel } from './devtoolsClient';+import type { Tab } from './devtoolsChannel';function tabFavicon(url: string): string {try {@@ -31,16 +32,17 @@ function tabFavicon(url: string): string {}}+const BUTTONS = ['left', 'middle', 'right'] as const;+export const DevTools: React.FC<{ wsUrl?: string }> = ({ wsUrl }) => {const [status, setStatus] = React.useState<{ text: string; cls: string }>({ text: 'Connecting', cls: '' });- const [tabs, setTabs] = React.useState<TabInfo[]>([]);- const [selectedPageId, setSelectedPageId] = React.useState<string | undefined>();+ const [tabs, setTabs] = React.useState<Tab[]>([]);const [url, setUrl] = React.useState('');const [frameSrc, setFrameSrc] = React.useState('');const [captured, setCaptured] = React.useState(false);const [hintVisible, setHintVisible] = React.useState(false);- const transportRef = React.useRef<DevToolsTransport | null>(null);+ const channelRef = React.useRef<DevToolsClientChannel | null>(null);const displayRef = React.useRef<HTMLImageElement>(null);const screenRef = React.useRef<HTMLDivElement>(null);const omniboxRef = React.useRef<HTMLInputElement>(null);@@ -57,34 +59,30 @@ export const DevTools: React.FC<{ wsUrl?: string }> = ({ wsUrl }) => {React.useEffect(() => {if (!wsUrl)return;- const transport = new DevToolsTransport(wsUrl);- transportRef.current = transport;+ const channel = DevToolsClient.create(wsUrl);+ channelRef.current = channel;- transport.onopen = () => setStatus({ text: 'Connected', cls: 'connected' });+ channel.onopen = () => setStatus({ text: 'Connected', cls: 'connected' });- transport.onevent = (method: string, params: any) => {- if (method === 'selectPage') {- setSelectedPageId(params.pageId);- if (params.pageId)- omniboxRef.current?.focus();- }- if (method === 'frame') {- setFrameSrc('data:image/jpeg;base64,' + params.data);- if (params.viewportWidth)- viewportSizeRef.current.width = params.viewportWidth;- if (params.viewportHeight)- viewportSizeRef.current.height = params.viewportHeight;- resizeToFit();- }- if (method === 'url')- setUrl(params.url);- if (method === 'tabs')- setTabs(params.tabs);- };+ channel.on('tabs', params => {+ setTabs(params.tabs);+ const selected = params.tabs.find(t => t.selected);+ if (selected)+ setUrl(selected.url);+ });- transport.onclose = () => setStatus({ text: 'Disconnected', cls: 'error' });+ channel.on('frame', params => {+ setFrameSrc('data:image/jpeg;base64,' + params.data);+ if (params.viewportWidth)+ viewportSizeRef.current.width = params.viewportWidth;+ if (params.viewportHeight)+ viewportSizeRef.current.height = params.viewportHeight;+ resizeToFit();+ });- return () => transport.close();+ channel.onclose = () => setStatus({ text: 'Disconnected', cls: 'error' });++ return () => channel.close();}, [wsUrl]);function resizeToFit() {@@ -134,8 +132,6 @@ export const DevTools: React.FC<{ wsUrl?: string }> = ({ wsUrl }) => {};}- const BUTTONS: string[] = ['left', 'middle', 'right'];-function onScreenMouseDown(e: React.MouseEvent) {e.preventDefault();screenRef.current?.focus();@@ -145,7 +141,7 @@ export const DevTools: React.FC<{ wsUrl?: string }> = ({ wsUrl }) => {return;}const { x, y } = imgCoords(e);- transportRef.current?.sendNoReply('mousedown', { x, y, button: BUTTONS[e.button] || 'left' });+ channelRef.current?.mousedown({ x, y, button: BUTTONS[e.button] || 'left' });}function onScreenMouseUp(e: React.MouseEvent) {@@ -153,7 +149,7 @@ export const DevTools: React.FC<{ wsUrl?: string }> = ({ wsUrl }) => {return;e.preventDefault();const { x, y } = imgCoords(e);- transportRef.current?.sendNoReply('mouseup', { x, y, button: BUTTONS[e.button] || 'left' });+ channelRef.current?.mouseup({ x, y, button: BUTTONS[e.button] || 'left' });}function onScreenMouseMove(e: React.MouseEvent) {@@ -164,14 +160,14 @@ export const DevTools: React.FC<{ wsUrl?: string }> = ({ wsUrl }) => {return;moveThrottleRef.current = now;const { x, y } = imgCoords(e);- transportRef.current?.sendNoReply('mousemove', { x, y });+ channelRef.current?.mousemove({ x, y });}function onScreenWheel(e: React.WheelEvent) {if (!capturedRef.current)return;e.preventDefault();- transportRef.current?.sendNoReply('wheel', { deltaX: e.deltaX, deltaY: e.deltaY });+ channelRef.current?.wheel({ deltaX: e.deltaX, deltaY: e.deltaY });}function onScreenKeyDown(e: React.KeyboardEvent) {@@ -182,14 +178,14 @@ export const DevTools: React.FC<{ wsUrl?: string }> = ({ wsUrl }) => {setCaptured(false);return;}- transportRef.current?.sendNoReply('keydown', { key: e.key });+ channelRef.current?.keydown({ key: e.key });}function onScreenKeyUp(e: React.KeyboardEvent) {if (!capturedRef.current)return;e.preventDefault();- transportRef.current?.sendNoReply('keyup', { key: e.key });+ channelRef.current?.keyup({ key: e.key });}function onScreenBlur() {@@ -203,12 +199,12 @@ export const DevTools: React.FC<{ wsUrl?: string }> = ({ wsUrl }) => {if (!/^https?:\/\//i.test(value))value = 'https://' + value;setUrl(value);- transportRef.current?.send('navigate', { url: value });+ channelRef.current?.navigate({ url: value });omniboxRef.current?.blur();}}- const hasPages = !!selectedPageId;+ const hasPages = tabs.some(t => t.selected);return (<div className='devtools-view'>{/* Tab bar */}@@ -221,12 +217,12 @@ export const DevTools: React.FC<{ wsUrl?: string }> = ({ wsUrl }) => {<div id='tabstrip' className='tabstrip' role='tablist'>{tabs.map(tab => (<div- key={tab.id}- className={'tab' + (tab.id === selectedPageId ? ' active' : '')}+ key={tab.pageId}+ className={'tab' + (tab.selected ? ' active' : '')}role='tab'- aria-selected={tab.id === selectedPageId}+ aria-selected={tab.selected}title={tab.url || ''}- onClick={() => transportRef.current?.sendNoReply('selectTab', { id: tab.id })}+ onClick={() => channelRef.current?.selectTab({ pageId: tab.pageId })}><span className='tab-favicon' aria-hidden='true'>{tabFavicon(tab.url)}</span><span className='tab-label'>{tab.title || 'New Tab'}</span>@@ -235,7 +231,7 @@ export const DevTools: React.FC<{ wsUrl?: string }> = ({ wsUrl }) => {title='Close tab'onClick={e => {e.stopPropagation();- transportRef.current?.sendNoReply('closeTab', { id: tab.id });+ channelRef.current?.closeTab({ pageId: tab.pageId });}}><svg viewBox='0 0 12 12' fill='none' stroke='currentColor' strokeWidth='1.5' strokeLinecap='round'>@@ -246,7 +242,7 @@ export const DevTools: React.FC<{ wsUrl?: string }> = ({ wsUrl }) => {</div>))}</div>- <button id='new-tab-btn' className='new-tab-btn' title='New Tab' onClick={() => transportRef.current?.sendNoReply('newTab')}>+ <button id='new-tab-btn' className='new-tab-btn' title='New Tab' onClick={() => channelRef.current?.newTab()}><svg viewBox='0 0 24 24' fill='none' stroke='currentColor' strokeWidth='2' strokeLinecap='round'><line x1='12' y1='5' x2='12' y2='19'/><line x1='5' y1='12' x2='19' y2='12'/>@@ -257,17 +253,17 @@ export const DevTools: React.FC<{ wsUrl?: string }> = ({ wsUrl }) => {{/* Toolbar */}<div className='toolbar'>- <button className='nav-btn' title='Back' onClick={() => transportRef.current?.sendNoReply('back')}>+ <button className='nav-btn' title='Back' onClick={() => channelRef.current?.back()}><svg viewBox='0 0 24 24' fill='none' stroke='currentColor' strokeWidth='2' strokeLinecap='round' strokeLinejoin='round'><polyline points='15 18 9 12 15 6'/></svg></button>- <button className='nav-btn' title='Forward' onClick={() => transportRef.current?.sendNoReply('forward')}>+ <button className='nav-btn' title='Forward' onClick={() => channelRef.current?.forward()}><svg viewBox='0 0 24 24' fill='none' stroke='currentColor' strokeWidth='2' strokeLinecap='round' strokeLinejoin='round'><polyline points='9 18 15 12 9 6'/></svg></button>- <button className='nav-btn' title='Reload' onClick={() => transportRef.current?.sendNoReply('reload')}>+ <button className='nav-btn' title='Reload' onClick={() => channelRef.current?.reload()}><svg viewBox='0 0 24 24' fill='none' stroke='currentColor' strokeWidth='2' strokeLinecap='round' strokeLinejoin='round'><polyline points='23 4 23 10 17 10'/><path d='M20.49 15a9 9 0 1 1-2.12-9.36L23 10'/>diff --git a/packages/devtools/src/devtoolsChannel.ts b/packages/devtools/src/devtoolsChannel.tsnew file mode 100644index 0000000000..bc940534eb--- /dev/null+++ b/packages/devtools/src/devtoolsChannel.ts@@ -0,0 +1,42 @@+/**+ * Copyright (c) Microsoft Corporation.+ *+ * 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.+ */++export type Tab = { pageId: string; title: string; url: string; selected: boolean };++export type DevToolsChannelEvents = {+ frame: { data: string; viewportWidth: number; viewportHeight: number };+ tabs: { tabs: Tab[] };+};++export interface DevToolsChannel {+ tabs(): Promise<{ tabs: Tab[] }>;+ selectTab(params: { pageId: string }): Promise<void>;+ closeTab(params: { pageId: string }): Promise<void>;+ newTab(): Promise<void>;+ navigate(params: { url: string }): Promise<void>;+ back(): Promise<void>;+ forward(): Promise<void>;+ reload(): Promise<void>;+ mousemove(params: { x: number; y: number }): Promise<void>;+ mousedown(params: { x: number; y: number; button?: 'left' | 'right' | 'middle' }): Promise<void>;+ mouseup(params: { x: number; y: number; button?: 'left' | 'right' | 'middle' }): Promise<void>;+ wheel(params: { deltaX: number; deltaY: number }): Promise<void>;+ keydown(params: { key: string }): Promise<void>;+ keyup(params: { key: string }): Promise<void>;++ on<K extends keyof DevToolsChannelEvents>(event: K, listener: (params: DevToolsChannelEvents[K]) => void): void;+ off<K extends keyof DevToolsChannelEvents>(event: K, listener: (params: DevToolsChannelEvents[K]) => void): void;+}diff --git a/packages/devtools/src/devtoolsClient.ts b/packages/devtools/src/devtoolsClient.tsnew file mode 100644index 0000000000..34c66e4d4b--- /dev/null+++ b/packages/devtools/src/devtoolsClient.ts@@ -0,0 +1,86 @@+/**+ * Copyright (c) Microsoft Corporation.+ *+ * 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 { Transport } from './transport';++import type { DevToolsChannel } from './devtoolsChannel';++export type DevToolsClientChannel = DevToolsChannel & {+ onopen?: () => void;+ onclose?: (reason?: string) => void;+ close(): void;+};++export class DevToolsClient {+ private _transport: Transport;+ private _listeners = new Map<string, Set<Function>>();++ onopen?: () => void;+ onclose?: (reason?: string) => void;++ private constructor(transport: Transport) {+ this._transport = transport;+ this._transport.onopen = () => {+ this.onopen?.();+ };+ this._transport.onevent = (method: string, params: any) => {+ this._fireEvent(method, params);+ };+ this._transport.onclose = (reason?: string) => {+ this.onclose?.(reason);+ };+ }++ static create(url: string): DevToolsClientChannel {+ const transport = new Transport(url);+ const client = new DevToolsClient(transport);+ return new Proxy(client, {+ get(target: DevToolsClient, prop: string | symbol, receiver: any): any {+ if (typeof prop === 'symbol' || prop in target)+ return Reflect.get(target, prop, receiver);+ // Prevent the proxy from being treated as a thenable.+ if (prop === 'then')+ return undefined;+ return (params?: any) => target._transport.send(prop, params);+ }+ }) as unknown as DevToolsClientChannel;+ }++ private _fireEvent(event: string, params: any) {+ const set = this._listeners.get(event);+ if (set) {+ for (const listener of set)+ listener(params);+ }+ }++ on(event: string, listener: Function): void {+ let set = this._listeners.get(event);+ if (!set) {+ set = new Set();+ this._listeners.set(event, set);+ }+ set.add(listener);+ }++ off(event: string, listener: Function): void {+ this._listeners.get(event)?.delete(listener);+ }++ close() {+ this._transport.close();+ }+}diff --git a/packages/devtools/src/grid.css b/packages/devtools/src/grid.cssindex 847571e769..e07eba0fad 100644--- a/packages/devtools/src/grid.css+++ b/packages/devtools/src/grid.css@@ -106,6 +106,7 @@align-items: center;gap: 8px;padding: 8px 12px;+ max-width: 533px;}.session-status-dot {@@ -127,6 +128,15 @@font-size: 13px;font-weight: 600;color: var(--fg);+ overflow: hidden;+ text-overflow: ellipsis;+ white-space: nowrap;+ min-width: 0;+}++.session-chip-title {+ color: var(--fg-muted);+ font-weight: 400;}.session-chip-detail {diff --git a/packages/devtools/src/grid.tsx b/packages/devtools/src/grid.tsxindex e474aa87a1..0850da8584 100644--- a/packages/devtools/src/grid.tsx+++ b/packages/devtools/src/grid.tsx@@ -16,10 +16,12 @@import React from 'react';import './grid.css';+import { DevToolsClient } from './devtoolsClient';import { navigate } from './index';import { Screencast } from './screencast';import type { SessionConfig } from '../../playwright/src/cli/client/registry';+import type { Tab } from './devtoolsChannel';import type { SessionModel, SessionStatus } from './sessionModel';export const Grid: React.FC<{ model: SessionModel }> = ({ model }) => {@@ -27,12 +29,6 @@ export const Grid: React.FC<{ model: SessionModel }> = ({ model }) => {const sessions = model.sessions;const clientInfo = model.clientInfo;- function browserLabel(config: SessionConfig): string {- if (config.resolvedConfig)- return config.resolvedConfig.browser.launchOptions.channel ?? config.resolvedConfig.browser.browserName;- return config.cli.browser || 'chromium';- }-function toggleWorkspace(workspace: string) {setExpandedWorkspaces(prev => {const next = new Set(prev);@@ -65,61 +61,6 @@ export const Grid: React.FC<{ model: SessionModel }> = ({ model }) => {return [...current, ...other];}, [sessions, clientInfo?.workspaceDir]);- function renderSessionChip(config: SessionConfig, canConnect: boolean, visible: boolean) {- const href = '#session=' + encodeURIComponent(config.socketPath);- const wsUrl = model.wsUrls.get(config.socketPath);- return (- <a key={config.socketPath} className={'session-chip' + (canConnect ? '' : ' disconnected')} href={canConnect ? href : undefined} onClick={e => {- e.preventDefault(); if (canConnect)- navigate(href);- }}>- <div className='session-chip-header'>- <div className={'session-status-dot ' + (canConnect ? 'open' : 'closed')} />- <span className='session-chip-name'>{config.name}</span>- <span className='session-chip-detail'>{browserLabel(config)}</span>- <span className='session-chip-detail'>v{config.version}</span>- {canConnect && (- <button- className='session-chip-action'- title='Close session'- onClick={e => {- e.preventDefault();- e.stopPropagation();- void model.closeSession(config);- }}- >- <svg viewBox='0 0 12 12' fill='none' stroke='currentColor' strokeWidth='1.5' strokeLinecap='round'>- <line x1='2' y1='2' x2='10' y2='10'/>- <line x1='10' y1='2' x2='2' y2='10'/>- </svg>- </button>- )}- {!canConnect && (- <button- className='session-chip-action'- title='Delete session data'- onClick={e => {- e.preventDefault();- e.stopPropagation();- void model.deleteSessionData(config);- }}- >- <svg viewBox='0 0 16 16' fill='none' stroke='currentColor' strokeWidth='1.2' strokeLinecap='round' strokeLinejoin='round'>- <path d='M2 4h12'/>- <path d='M5 4V3a1 1 0 0 1 1-1h4a1 1 0 0 1 1 1v1'/>- <path d='M4 4l.8 9a1 1 0 0 0 1 .9h4.4a1 1 0 0 0 1-.9L12 4'/>- </svg>- </button>- )}- </div>- <div className='screencast-container'>- {canConnect && visible && wsUrl && <Screencast wsUrl={wsUrl} />}- {!canConnect && <div className='screencast-placeholder'>Session closed</div>}- </div>- </a>- );- }-return (<div className='grid-view'>{model.loading && sessions.length === 0 && <div className='grid-loading'>Loading sessions...</div>}{model.error && <div className='grid-error'>Error: {model.error}</div>}@@ -145,7 +86,7 @@ export const Grid: React.FC<{ model: SessionModel }> = ({ model }) => {</div>{isExpanded && (<div className='session-chips'>- {entries.map(({ config, canConnect }) => renderSessionChip(config, canConnect, isExpanded))}+ {entries.map(({ config, canConnect }) => <SessionChip key={config.socketPath} config={config} canConnect={canConnect} visible={isExpanded} model={model} />)}</div>)}</div>@@ -154,3 +95,84 @@ export const Grid: React.FC<{ model: SessionModel }> = ({ model }) => {</div></div>);};++const SessionChip: React.FC<{ config: SessionConfig; canConnect: boolean; visible: boolean; model: SessionModel }> = ({ config, canConnect, visible, model }) => {+ const href = '#session=' + encodeURIComponent(config.socketPath);+ const wsUrl = model.wsUrls.get(config.socketPath);++ const channel = React.useMemo(() => {+ if (!canConnect || !visible || !wsUrl)+ return undefined;+ return DevToolsClient.create(wsUrl);+ }, [canConnect, visible, wsUrl]);++ const [selectedTab, setSelectedTab] = React.useState<Tab | undefined>();++ React.useEffect(() => {+ if (!channel)+ return;+ const onTabs = (params: { tabs: Tab[] }) => {+ setSelectedTab(params.tabs.find(t => t.selected));+ };+ channel.tabs().then(onTabs);+ channel.on('tabs', onTabs);+ return () => {+ channel.off('tabs', onTabs);+ channel.close();+ };+ }, [channel]);++ const chipTitle = selectedTab ? `[${config.name}] ${selectedTab.url} \u2014 ${selectedTab.title}` : config.name;++ return (+ <a className={'session-chip' + (canConnect ? '' : ' disconnected')} href={canConnect ? href : undefined} title={chipTitle} onClick={e => {+ e.preventDefault();+ if (canConnect)+ navigate(href);+ }}>+ <div className='session-chip-header'>+ <div className={'session-status-dot ' + (canConnect ? 'open' : 'closed')} />+ <span className='session-chip-name'>+ {selectedTab ? <>[{config.name}] {selectedTab.url} <span className='session-chip-title'>— {selectedTab.title}</span></> : config.name}+ </span>+ {canConnect && (+ <button+ className='session-chip-action'+ title='Close session'+ onClick={e => {+ e.preventDefault();+ e.stopPropagation();+ void model.closeSession(config);+ }}+ >+ <svg viewBox='0 0 12 12' fill='none' stroke='currentColor' strokeWidth='1.5' strokeLinecap='round'>+ <line x1='2' y1='2' x2='10' y2='10'/>+ <line x1='10' y1='2' x2='2' y2='10'/>+ </svg>+ </button>+ )}+ {!canConnect && (+ <button+ className='session-chip-action'+ title='Delete session data'+ onClick={e => {+ e.preventDefault();+ e.stopPropagation();+ void model.deleteSessionData(config);+ }}+ >+ <svg viewBox='0 0 16 16' fill='none' stroke='currentColor' strokeWidth='1.2' strokeLinecap='round' strokeLinejoin='round'>+ <path d='M2 4h12'/>+ <path d='M5 4V3a1 1 0 0 1 1-1h4a1 1 0 0 1 1 1v1'/>+ <path d='M4 4l.8 9a1 1 0 0 0 1 .9h4.4a1 1 0 0 0 1-.9L12 4'/>+ </svg>+ </button>+ )}+ </div>+ <div className='screencast-container'>+ {channel && <Screencast channel={channel} />}+ {!canConnect && <div className='screencast-placeholder'>Session closed</div>}+ </div>+ </a>+ );+};diff --git a/packages/devtools/src/screencast.tsx b/packages/devtools/src/screencast.tsxindex d537614a8d..f48dd16c7b 100644--- a/packages/devtools/src/screencast.tsx+++ b/packages/devtools/src/screencast.tsx@@ -15,19 +15,19 @@*/import React from 'react';-import { DevToolsTransport } from './transport';-export const Screencast: React.FC<{ wsUrl: string }> = ({ wsUrl }) => {+import type { DevToolsClientChannel } from './devtoolsClient';++export const Screencast: React.FC<{ channel: DevToolsClientChannel }> = ({ channel }) => {const [frameSrc, setFrameSrc] = React.useState('');React.useEffect(() => {- const transport = new DevToolsTransport(wsUrl);- transport.onevent = (method: string, params: any) => {- if (method === 'frame')- setFrameSrc('data:image/jpeg;base64,' + params.data);+ const listener = (params: { data: string }) => {+ setFrameSrc('data:image/jpeg;base64,' + params.data);};- return () => transport.close();- }, [wsUrl]);+ channel.on('frame', listener);+ return () => channel.off('frame', listener);+ }, [channel]);if (!frameSrc)return <div className='screencast-placeholder'>Connecting...</div>;diff --git a/packages/devtools/src/transport.ts b/packages/devtools/src/transport.tsindex 65029b104b..61399adc17 100644--- a/packages/devtools/src/transport.ts+++ b/packages/devtools/src/transport.ts@@ -14,10 +14,11 @@* limitations under the License.*/-export class DevToolsTransport {+export class Transport {private _ws: WebSocket;private _lastId = 0;private _pending = new Map<number, { resolve: (result: any) => void; reject: (error: Error) => void }>();+ private _sendQueue: string[] | undefined = [];onopen?: () => void;onevent?: (method: string, params: any) => void;@@ -26,6 +27,9 @@ export class DevToolsTransport {constructor(url: string) {this._ws = new WebSocket(url);this._ws.onopen = () => {+ for (const message of this._sendQueue || [])+ this._ws.send(message);+ this._sendQueue = undefined;if (this.onopen)this.onopen();};@@ -67,7 +71,11 @@ export class DevToolsTransport {send(method: string, params?: any): Promise<any> {const id = ++this._lastId;- this._ws.send(JSON.stringify({ id, method, params }));+ const message = JSON.stringify({ id, method, params });+ if (this._sendQueue)+ this._sendQueue.push(message);+ else+ this._ws.send(message);return new Promise((resolve, reject) => {this._pending.set(id, { resolve, reject });});diff --git a/packages/playwright-core/src/server/devtoolsController.ts b/packages/playwright-core/src/server/devtoolsController.tsindex b43db31081..30ada58b4a 100644--- a/packages/playwright-core/src/server/devtoolsController.ts+++ b/packages/playwright-core/src/server/devtoolsController.ts@@ -22,6 +22,7 @@ import { ProgressController } from './progress';import type { RegisteredListener } from '../utils';import type { Transport } from './utils/httpServer';+import type { DevToolsChannel, DevToolsChannelEvents, Tab } from '@devtools/devtoolsChannel';export class DevToolsController {private _context: BrowserContext;@@ -48,7 +49,7 @@ export class DevToolsController {}}-class DevToolsConnection implements Transport {+class DevToolsConnection implements Transport, DevToolsChannel {sendEvent?: (method: string, params: any) => void;close?: () => void;@@ -58,11 +59,39 @@ class DevToolsConnection implements Transport {private _pageListeners: RegisteredListener[] = [];private _contextListeners: RegisteredListener[] = [];private _context: BrowserContext;+ private _eventListeners = new Map<string, Set<Function>>();constructor(context: BrowserContext) {this._context = context;}+ // -- IDevToolsConnection: event subscription --++ on<K extends keyof DevToolsChannelEvents>(event: K, listener: (params: DevToolsChannelEvents[K]) => void): void {+ let set = this._eventListeners.get(event);+ if (!set) {+ set = new Set();+ this._eventListeners.set(event, set);+ }+ set.add(listener);+ }++ off<K extends keyof DevToolsChannelEvents>(event: K, listener: (params: DevToolsChannelEvents[K]) => void): void {+ this._eventListeners.get(event)?.delete(listener);+ }++ /** Sends an event to the remote client and notifies local listeners. */+ private _emit<K extends keyof DevToolsChannelEvents>(event: K, params: DevToolsChannelEvents[K]): void {+ this.sendEvent?.(event, params);+ const set = this._eventListeners.get(event);+ if (set) {+ for (const fn of set)+ fn(params);+ }+ }++ // -- Transport: lifecycle --+onconnect() {const context = this._context;@@ -78,17 +107,12 @@ class DevToolsConnection implements Transport {const pages = context.pages();if (pages.length > 0)this._selectPage(pages[0]);- else- this.sendEvent?.('selectPage', { pageId: undefined });}this._sendTabList();}),eventsHelper.addEventListener(context, BrowserContext.Events.InternalFrameNavigatedToNewDocument, (frame, page) => {- if (frame === page.mainFrame()) {+ if (frame === page.mainFrame())this._sendTabList();- if (page === this.selectedPage)- this.sendEvent?.('url', { url: frame.url() });- }}),);@@ -106,55 +130,105 @@ class DevToolsConnection implements Transport {this._contextListeners = [];}+ // -- Transport: dispatch (skeleton) --+async dispatch(method: string, params: any): Promise<any> {- if (method === 'selectTab') {- const page = this._context.pages().find(p => p.guid === params.id);- if (page)- await this._selectPage(page);+ return (this as any)[method]?.(params);+ }++ // -- IDevToolsConnection: RPC method implementations --++ async selectTab(params: { pageId: string }) {+ const page = this._context.pages().find(p => p.guid === params.pageId);+ if (page)+ await this._selectPage(page);+ }++ async closeTab(params: { pageId: string }) {+ const page = this._context.pages().find(p => p.guid === params.pageId);+ if (page)+ await page.close({ reason: 'Closed from devtools' });+ }++ async newTab() {+ await ProgressController.runInternalTask(async progress => {+ const page = await this._context.newPage(progress);+ await this._selectPage(page);+ });+ }++ async navigate(params: { url: string }) {+ if (!this.selectedPage || !params.url)return;- }+ const page = this.selectedPage;+ await ProgressController.runInternalTask(async progress => { await page.mainFrame().goto(progress, params.url); });+ }- if (method === 'closeTab') {- const page = this._context.pages().find(p => p.guid === params.id);- if (page)- await page.close({ reason: 'Closed from devtools' });+ async back() {+ if (!this.selectedPage)return;- }+ const page = this.selectedPage;+ await ProgressController.runInternalTask(async progress => { await page.goBack(progress, {}); });+ }- if (method === 'newTab') {- await ProgressController.runInternalTask(async progress => {- const page = await this._context.newPage(progress);- await this._selectPage(page);- });+ async forward() {+ if (!this.selectedPage)return;- }+ const page = this.selectedPage;+ await ProgressController.runInternalTask(async progress => { await page.goForward(progress, {}); });+ }++ async reload() {+ if (!this.selectedPage)+ return;+ const page = this.selectedPage;+ await ProgressController.runInternalTask(async progress => { await page.reload(progress, {}); });+ }++ async mousemove(params: { x: number; y: number }) {+ if (!this.selectedPage)+ return;+ const page = this.selectedPage;+ await ProgressController.runInternalTask(async progress => { await page.mouse.move(progress, params.x, params.y); });+ }++ async mousedown(params: { x: number; y: number; button?: 'left' | 'right' | 'middle' }) {+ if (!this.selectedPage)+ return;+ const page = this.selectedPage;+ await ProgressController.runInternalTask(async progress => { await page.mouse.move(progress, params.x, params.y); await page.mouse.down(progress, { button: params.button || 'left' }); });+ }++ async mouseup(params: { x: number; y: number; button?: 'left' | 'right' | 'middle' }) {+ if (!this.selectedPage)+ return;+ const page = this.selectedPage;+ await ProgressController.runInternalTask(async progress => { await page.mouse.move(progress, params.x, params.y); await page.mouse.up(progress, { button: params.button || 'left' }); });+ }+ async wheel(params: { deltaX: number; deltaY: number }) {if (!this.selectedPage)return;+ const page = this.selectedPage;+ await ProgressController.runInternalTask(async progress => { await page.mouse.wheel(progress, params.deltaX, params.deltaY); });+ }+ async keydown(params: { key: string }) {+ if (!this.selectedPage)+ return;const page = this.selectedPage;- if (method === 'navigate' && params.url)- await ProgressController.runInternalTask(async progress => { await page.mainFrame().goto(progress, params.url); });- else if (method === 'back')- await ProgressController.runInternalTask(async progress => { await page.goBack(progress, {}); });- else if (method === 'forward')- await ProgressController.runInternalTask(async progress => { await page.goForward(progress, {}); });- else if (method === 'reload')- await ProgressController.runInternalTask(async progress => { await page.reload(progress, {}); });- else if (method === 'mousemove')- await ProgressController.runInternalTask(async progress => { await page.mouse.move(progress, params.x, params.y); });- else if (method === 'mousedown')- await ProgressController.runInternalTask(async progress => { await page.mouse.move(progress, params.x, params.y); await page.mouse.down(progress, { button: params.button || 'left' }); });- else if (method === 'mouseup')- await ProgressController.runInternalTask(async progress => { await page.mouse.move(progress, params.x, params.y); await page.mouse.up(progress, { button: params.button || 'left' }); });- else if (method === 'wheel')- await ProgressController.runInternalTask(async progress => { await page.mouse.wheel(progress, params.deltaX, params.deltaY); });- else if (method === 'keydown')- await ProgressController.runInternalTask(async progress => { await page.keyboard.down(progress, params.key); });- else if (method === 'keyup')- await ProgressController.runInternalTask(async progress => { await page.keyboard.up(progress, params.key); });+ await ProgressController.runInternalTask(async progress => { await page.keyboard.down(progress, params.key); });}+ async keyup(params: { key: string }) {+ if (!this.selectedPage)+ return;+ const page = this.selectedPage;+ await ProgressController.runInternalTask(async progress => { await page.keyboard.up(progress, params.key); });+ }++ // -- Internal helpers --+private async _selectPage(page: Page) {if (this.selectedPage === page)return;@@ -169,7 +243,7 @@ class DevToolsConnection implements Transport {this.selectedPage = page;this._lastFrameData = null;this._lastViewportSize = null;- this.sendEvent?.('selectPage', { pageId: page.guid });+ this._sendTabList();// Start screencast on new page.this._pageListeners.push(@@ -177,11 +251,6 @@ class DevToolsConnection implements Transport {);await page.screencast.startScreencast(this, { width: 800, height: 600, quality: 90 });-- // Send URL to this client.- const url = page.mainFrame().url();- if (url)- this.sendEvent?.('url', { url });}private _deselectPage() {@@ -196,33 +265,32 @@ class DevToolsConnection implements Transport {}private _sendCachedState() {- this.sendEvent?.('selectPage', { pageId: this.selectedPage?.guid });- if (this._lastFrameData)- this.sendEvent?.('frame', { data: this._lastFrameData, viewportWidth: this._lastViewportSize?.width, viewportHeight: this._lastViewportSize?.height });- if (this.selectedPage) {- const url = this.selectedPage.mainFrame().url();- if (url)- this.sendEvent?.('url', { url });- }+ if (this._lastFrameData && this._lastViewportSize)+ this._emit('frame', { data: this._lastFrameData, viewportWidth: this._lastViewportSize.width, viewportHeight: this._lastViewportSize.height });this._sendTabList();}- private async _tabList(): Promise<{ id: string, title: string, url: string }[]> {+ async tabs(): Promise<{ tabs: Tab[] }> {+ return { tabs: await this._tabList() };+ }++ private async _tabList(): Promise<Tab[]> {return await Promise.all(this._context.pages().map(async page => ({- id: page.guid,+ pageId: page.guid,title: await page.mainFrame().title().catch(() => '') || page.mainFrame().url(),url: page.mainFrame().url(),+ selected: page === this.selectedPage,})));}private _sendTabList() {- this._tabList().then(tabs => this.sendEvent?.('tabs', { tabs }));+ this._tabList().then(tabs => this._emit('tabs', { tabs }));}private _writeFrame(frame: Buffer, viewportWidth: number, viewportHeight: number) {const data = frame.toString('base64');this._lastFrameData = data;this._lastViewportSize = { width: viewportWidth, height: viewportHeight };- this.sendEvent?.('frame', { data, viewportWidth, viewportHeight });+ this._emit('frame', { data, viewportWidth, viewportHeight });}}diff --git a/tests/tsconfig.json b/tests/tsconfig.jsonindex a921b85a09..2ffc326c74 100644--- a/tests/tsconfig.json+++ b/tests/tsconfig.json@@ -11,6 +11,7 @@"useUnknownInCatchVariables": false,"baseUrl": "..","paths": {+ "@dvtools/*": ["packages/devtools/src/*"],"@isomorphic/*": ["packages/playwright-core/src/utils/isomorphic/*"],"@testIsomorphic/*": ["packages/playwright/src/isomorphic/*"],"@protocol/*": ["packages/protocol/src/*"],diff --git a/tsconfig.json b/tsconfig.jsonindex 268c30e76b..2b8a7d80ed 100644--- a/tsconfig.json+++ b/tsconfig.json@@ -9,6 +9,7 @@- @foo/* is for importing types only,- .../lib/* means require dependency*/+ "@devtools/*": ["./packages/devtools/src/*"],"@html-reporter/*": ["./packages/html-reporter/src/*"],"@injected/*": ["./packages/injected/src/*"],"@isomorphic/*": ["./packages/playwright-core/src/utils/isomorphic/*"],