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
Revert "feat(mcp): support multiple tabs in extension cdpRelay (#40104)" (#40171)
Yury Semikhatskyc209a5549033
diff --git a/packages/playwright-core/src/tools/mcp/cdpRelay.ts b/packages/playwright-core/src/tools/mcp/cdpRelay.tsindex cb42dd89b8..79832104b6 100644--- a/packages/playwright-core/src/tools/mcp/cdpRelay.ts+++ b/packages/playwright-core/src/tools/mcp/cdpRelay.ts@@ -19,13 +19,7 @@** Endpoints:* - /cdp/guid - Full CDP interface for Playwright MCP- * - /extension/guid - Extension connection that exposes a thin chrome.* RPC.- *- * The relay owns CDP session management: it asks the extension for the user's- * tab pick (extension.selectTab), then attaches the debugger and dispatches- * Target.attachedToTarget events to Playwright. Additional tabs are created- * either by Playwright (Target.createTarget → chrome.tabs.create) or by the- * controlled tabs themselves (chrome.tabs.onCreated event from the extension).+ * - /extension/guid - Extension connection for chrome.debugger forwarding*/import { spawn } from 'child_process';@@ -64,15 +58,6 @@ type CDPResponse = {error?: { code?: number; message: string };};-type TabSession = {- tabId: number;- sessionId: string;- targetInfo: any;- // Child CDP sessionIds (workers, oopifs, ...) belonging to this tab,- // tracked via Target.attachedToTarget / Target.detachedFromTarget events.- childSessions: Set<string>;-};-export class CDPRelayServer {private _wsHost: string;private _browserChannel: string;@@ -83,10 +68,13 @@ export class CDPRelayServer {private _wss: WebSocketServer;private _playwrightConnection: WebSocket | null = null;private _extensionConnection: ExtensionConnection | null = null;- private _extensionConnectionPromise!: ManualPromise<void>;-- private _tabSessions = new Map<number, TabSession>();+ private _connectedTabInfo: {+ targetInfo: any;+ // Page sessionId that should be used by this connection.+ sessionId: string;+ } | undefined;private _nextSessionId: number = 1;+ private _extensionConnectionPromise!: ManualPromise<void>;constructor(server: http.Server, browserChannel: string, userDataDir?: string, executablePath?: string) {this._wsHost = addressToString(server.address(), { protocol: 'ws' });@@ -226,28 +214,12 @@ export class CDPRelayServer {}private _resetExtensionConnection() {- this._tabSessions.clear();+ this._connectedTabInfo = undefined;this._extensionConnection = null;this._extensionConnectionPromise = new ManualPromise();void this._extensionConnectionPromise.catch(logUnhandledError);}- private _findTabSessionBySessionId(sessionId: string): TabSession | undefined {- for (const session of this._tabSessions.values()) {- if (session.sessionId === sessionId)- return session;- }- return undefined;- }-- private _findTabSessionByChildSessionId(childSessionId: string): TabSession | undefined {- for (const session of this._tabSessions.values()) {- if (session.childSessions.has(childSessionId))- return session;- }- return undefined;- }-private _closePlaywrightConnection(reason: string) {if (this._playwrightConnection?.readyState === ws.OPEN)this._playwrightConnection.close(1000, reason);@@ -273,92 +245,17 @@ export class CDPRelayServer {private _handleExtensionMessage<M extends keyof ExtensionEvents>(method: M, params: ExtensionEvents[M]['params']) {switch (method) {- case 'chrome.debugger.onEvent': {- const [source, cdpMethod, cdpParams] = params as ExtensionEvents['chrome.debugger.onEvent']['params'];- if (source.tabId === undefined)- return;- const tabSession = this._tabSessions.get(source.tabId);- if (!tabSession)- return;- // Track child CDP sessions so we can route subsequent commands for- // them to the correct tab. Target.attachedToTarget introduces a new- // sessionId belonging to the same tab; Target.detachedFromTarget- // releases it.- const childSessionId = (cdpParams as { sessionId?: string } | undefined)?.sessionId;- if (cdpMethod === 'Target.attachedToTarget' && childSessionId)- tabSession.childSessions.add(childSessionId);- else if (cdpMethod === 'Target.detachedFromTarget' && childSessionId)- tabSession.childSessions.delete(childSessionId);- // Top-level CDP events for the tab use the tab's relay sessionId.- // Child CDP sessions (workers, oopifs) keep their own sessionId.- const sessionId = source.sessionId || tabSession.sessionId;+ case 'forwardCDPEvent':+ const sessionId = params.sessionId || this._connectedTabInfo?.sessionId;this._sendToPlaywright({sessionId,- method: cdpMethod,- params: cdpParams,+ method: params.method,+ params: params.params});break;- }- case 'chrome.debugger.onDetach': {- const [source] = params as ExtensionEvents['chrome.debugger.onDetach']['params'];- if (source.tabId !== undefined)- this._detachTab(source.tabId);- break;- }- case 'chrome.tabs.onCreated': {- const [tab] = params as ExtensionEvents['chrome.tabs.onCreated']['params'];- // A controlled tab opened a popup. Attach to it.- if (tab.id !== undefined)- void this._attachTab(tab.id).catch(logUnhandledError);- break;- }- case 'chrome.tabs.onRemoved': {- const [tabId] = params as ExtensionEvents['chrome.tabs.onRemoved']['params'];- this._detachTab(tabId);- break;- }}}- private async _attachTab(tabId: number): Promise<TabSession> {- const existing = this._tabSessions.get(tabId);- if (existing)- return existing;- if (!this._extensionConnection)- throw new Error('Extension not connected');- await this._extensionConnection.send('chrome.debugger.attach', [{ tabId }, '1.3']);- const result = await this._extensionConnection.send('chrome.debugger.sendCommand', [- { tabId },- 'Target.getTargetInfo',- ]);- const targetInfo = result?.targetInfo;- const sessionId = `pw-tab-${this._nextSessionId++}`;- const tabSession: TabSession = { tabId, sessionId, targetInfo, childSessions: new Set() };- this._tabSessions.set(tabId, tabSession);- debugLogger(`Attached tab ${tabId} as session ${sessionId}`);- this._sendToPlaywright({- method: 'Target.attachedToTarget',- params: {- sessionId,- targetInfo: { ...targetInfo, attached: true },- waitingForDebugger: false,- },- });- return tabSession;- }-- private _detachTab(tabId: number): void {- const tabSession = this._tabSessions.get(tabId);- if (!tabSession)- return;- this._tabSessions.delete(tabId);- debugLogger(`Detached tab ${tabId} (session ${tabSession.sessionId})`);- this._sendToPlaywright({- method: 'Target.detachedFromTarget',- params: { sessionId: tabSession.sessionId },- });- }-private async _handlePlaywrightMessage(message: CDPCommand): Promise<void> {debugLogger('← Playwright:', `${message.method} (id=${message.id})`);const { id, sessionId, method, params } = message;@@ -391,53 +288,40 @@ export class CDPRelayServer {// Forward child session handling.if (sessionId)break;- // Ask the user to pick the initial tab via the connect UI, then attach.- if (!this._extensionConnection)- throw new Error('Extension not connected');- const { tabId } = await this._extensionConnection.send('extension.selectTab', []);- await this._attachTab(tabId);+ // Simulate auto-attach behavior with real target info+ const { targetInfo } = await this._extensionConnection!.send('attachToTab', { });+ this._connectedTabInfo = {+ targetInfo,+ sessionId: `pw-tab-${this._nextSessionId++}`,+ };+ debugLogger('Simulating auto-attach');+ this._sendToPlaywright({+ method: 'Target.attachedToTarget',+ params: {+ sessionId: this._connectedTabInfo.sessionId,+ targetInfo: {+ ...this._connectedTabInfo.targetInfo,+ attached: true,+ },+ waitingForDebugger: false+ }+ });return { };}- case 'Target.createTarget': {- if (!this._extensionConnection)- throw new Error('Extension not connected');- const tab = await this._extensionConnection.send('chrome.tabs.create', [{ url: params?.url }]);- if (tab?.id === undefined)- throw new Error('Failed to create tab');- const tabSession = await this._attachTab(tab.id);- return { targetId: tabSession.targetInfo?.targetId };- }case 'Target.getTargetInfo': {- if (!sessionId)- return undefined;- return this._findTabSessionBySessionId(sessionId)?.targetInfo;+ return this._connectedTabInfo?.targetInfo;}}- if (!sessionId)- throw new Error(`Unsupported command without sessionId: ${method}`);return await this._forwardToExtension(method, params, sessionId);}- private async _forwardToExtension(method: string, params: any, sessionId: string): Promise<any> {+ private async _forwardToExtension(method: string, params: any, sessionId: string | undefined): Promise<any> {if (!this._extensionConnection)throw new Error('Extension not connected');- // Resolve the sessionId to a tab session. Two cases:- // 1. sessionId is a relay-level tab session (pw-tab-N) → strip and route by tabId.- // 2. sessionId is a child CDP session (worker, oopif) → route to its owning tab,- // keep the sessionId so the extension forwards it to chrome.debugger.- let tabSession = this._findTabSessionBySessionId(sessionId);- let cdpSessionId: string | undefined;- if (!tabSession) {- tabSession = this._findTabSessionByChildSessionId(sessionId);- cdpSessionId = sessionId;- }- if (!tabSession)- throw new Error(`No tab found for sessionId: ${sessionId}`);- return await this._extensionConnection.send('chrome.debugger.sendCommand', [- { tabId: tabSession.tabId, sessionId: cdpSessionId },- method,- params,- ]);+ // Top level sessionId is only passed between the relay and the client.+ if (this._connectedTabInfo?.sessionId === sessionId)+ sessionId = undefined;+ return await this._extensionConnection.send('forwardCDPCommand', { sessionId, method, params });}private _sendToPlaywright(message: CDPResponse): void {@@ -469,7 +353,7 @@ class ExtensionConnection {this._ws.on('error', this._onError.bind(this));}- async send<M extends keyof ExtensionCommand>(method: M, params: ExtensionCommand[M]['params']): Promise<ExtensionCommand[M]['result']> {+ async send<M extends keyof ExtensionCommand>(method: M, params: ExtensionCommand[M]['params']): Promise<any> {if (this._ws.readyState !== ws.OPEN)throw new Error(`Unexpected WebSocket state: ${this._ws.readyState}`);const id = ++this._lastId;diff --git a/packages/playwright-core/src/tools/mcp/protocol.ts b/packages/playwright-core/src/tools/mcp/protocol.tsindex 349c09a8c6..7b0cb26166 100644--- a/packages/playwright-core/src/tools/mcp/protocol.ts+++ b/packages/playwright-core/src/tools/mcp/protocol.ts@@ -16,88 +16,11 @@// Whenever the commands/events change, the version must be updated. The latest// extension version should be compatible with the old MCP clients.-export const VERSION = 2;+export const VERSION = 1;-// Structural mirrors of @types/chrome shapes used over the wire. The extension-// imports the real chrome.* types and they are structurally compatible.-export type Debuggee = { tabId?: number; extensionId?: string; targetId?: string };-export type DebuggerSession = Debuggee & { sessionId?: string };-export type TabCreateProperties = {- active?: boolean;- index?: number;- openerTabId?: number;- pinned?: boolean;- url?: string;- windowId?: number;-};-export type Tab = {- id?: number;- index: number;- windowId: number;- openerTabId?: number;- url?: string;- title?: string;- active: boolean;- pinned: boolean;-};-export type TabRemoveInfo = { windowId: number; isWindowClosing: boolean };--// Protocol v2: command params/results mirror chrome.* positional arguments,-// so the extension can spread them straight into chrome.<api>.<method>(...).export type ExtensionCommand = {- // chrome.debugger.attach(target, requiredVersion)- 'chrome.debugger.attach': {- params: [target: Debuggee, requiredVersion: string];- result: void;- };- // chrome.debugger.detach(target)- 'chrome.debugger.detach': {- params: [target: Debuggee];- result: void;- };- // chrome.debugger.sendCommand(target, method, commandParams?)- 'chrome.debugger.sendCommand': {- params: [target: DebuggerSession, method: string, commandParams?: object];- result: any;- };- // chrome.tabs.create(createProperties)- 'chrome.tabs.create': {- params: [createProperties: TabCreateProperties];- result: Tab;- };- // Playwright-specific: ask the user to pick a tab via the connect UI.- 'extension.selectTab': {- params: [];- result: { tabId: number };- };-};--// Event params mirror chrome.<api>.<event>.addListener callback signatures.-export type ExtensionEvents = {- // chrome.debugger.onEvent: (source, method, params?) => void- 'chrome.debugger.onEvent': {- params: [source: DebuggerSession, method: string, eventParams?: object];- };- // chrome.debugger.onDetach: (source, reason) => void- 'chrome.debugger.onDetach': {- params: [source: Debuggee, reason: string];- };- // chrome.tabs.onCreated: (tab) => void- 'chrome.tabs.onCreated': {- params: [tab: Tab];- };- // chrome.tabs.onRemoved: (tabId, removeInfo) => void- 'chrome.tabs.onRemoved': {- params: [tabId: number, removeInfo: TabRemoveInfo];- };-};--// Protocol v1: legacy single-tab interface. Kept for backward compatibility-// with older MCP clients; will be removed in a future release.-export type ExtensionCommandV1 = {'attachToTab': {params: {};- result: { targetInfo: any };};'forwardCDPCommand': {params: {@@ -105,11 +28,10 @@ export type ExtensionCommandV1 = {sessionId?: stringparams?: any,};- result: any;};};-export type ExtensionEventsV1 = {+export type ExtensionEvents = {'forwardCDPEvent': {params: {method: string,