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: remove cdp port from launch options (#40190)
Pavel Feldman4b1b9d681f8a
diff --git a/packages/playwright-core/src/protocol/validator.ts b/packages/playwright-core/src/protocol/validator.tsindex 5788140676..cca67f6407 100644--- a/packages/playwright-core/src/protocol/validator.ts+++ b/packages/playwright-core/src/protocol/validator.ts@@ -511,7 +511,6 @@ scheme.BrowserTypeLaunchParams = tObject({args: tOptional(tArray(tString)),ignoreAllDefaultArgs: tOptional(tBoolean),ignoreDefaultArgs: tOptional(tArray(tString)),- assistantMode: tOptional(tBoolean),handleSIGINT: tOptional(tBoolean),handleSIGTERM: tOptional(tBoolean),handleSIGHUP: tOptional(tBoolean),@@ -541,7 +540,6 @@ scheme.BrowserTypeLaunchPersistentContextParams = tObject({args: tOptional(tArray(tString)),ignoreAllDefaultArgs: tOptional(tBoolean),ignoreDefaultArgs: tOptional(tArray(tString)),- assistantMode: tOptional(tBoolean),handleSIGINT: tOptional(tBoolean),handleSIGTERM: tOptional(tBoolean),handleSIGHUP: tOptional(tBoolean),diff --git a/packages/playwright-core/src/server/android/android.ts b/packages/playwright-core/src/server/android/android.tsindex 801ae85cfe..b1b57da6e6 100644--- a/packages/playwright-core/src/server/android/android.ts+++ b/packages/playwright-core/src/server/android/android.ts@@ -299,7 +299,7 @@ export class AndroidDevice extends SdkObject {'--disable-fre','--no-default-browser-check',`--remote-debugging-socket-name=${socketName}`,- ...chromiumSwitches(undefined, undefined, true),+ ...chromiumSwitches({ android: true }),...this._innerDefaultArgs(options)];return chromeArguments;diff --git a/packages/playwright-core/src/server/bidi/bidiChromium.ts b/packages/playwright-core/src/server/bidi/bidiChromium.tsindex 9cdd1da833..2e02b92958 100644--- a/packages/playwright-core/src/server/bidi/bidiChromium.ts+++ b/packages/playwright-core/src/server/bidi/bidiChromium.ts@@ -102,7 +102,7 @@ export class BidiChromium extends BrowserType {}override async waitForReadyState(options: types.LaunchOptions, browserLogsCollector: RecentLogsCollector): Promise<{ wsEndpoint?: string }> {- return waitForReadyState({ ...options, cdpPort: 0 }, browserLogsCollector);+ return waitForReadyState({ ...options, args: ['--remote-debugging-port=0'] }, browserLogsCollector);}private _innerDefaultArgs(options: types.LaunchOptions): string[] {@@ -114,7 +114,7 @@ export class BidiChromium extends BrowserType {throw new Error('Playwright manages remote debugging connection itself.');if (args.find(arg => !arg.startsWith('-')))throw new Error('Arguments can not specify page to be opened');- const chromeArguments = [...chromiumSwitches(options.assistantMode)];+ const chromeArguments = [...chromiumSwitches()];if (os.platform() === 'darwin') {// See https://issues.chromium.org/issues/40277080diff --git a/packages/playwright-core/src/server/browser.ts b/packages/playwright-core/src/server/browser.tsindex 1967a9549a..bdd7dfe8e7 100644--- a/packages/playwright-core/src/server/browser.ts+++ b/packages/playwright-core/src/server/browser.ts@@ -59,7 +59,7 @@ export type BrowserOptions = {protocolLogger: types.ProtocolLogger,browserLogsCollector: RecentLogsCollector,slowMo?: number;- wsEndpoint?: string; // Only there when connected over web socket.+ wsEndpoint?: string;sdkLanguage?: Language;originalLaunchOptions: types.LaunchOptions;userDataDir?: string;diff --git a/packages/playwright-core/src/server/browserType.ts b/packages/playwright-core/src/server/browserType.tsindex c4787cb3f6..f0503d2457 100644--- a/packages/playwright-core/src/server/browserType.ts+++ b/packages/playwright-core/src/server/browserType.ts@@ -72,7 +72,7 @@ export abstract class BrowserType extends SdkObject {return this._innerLaunchWithRetries(progress, options, undefined, helper.debugProtocolLogger(protocolLogger)).catch(e => { throw this._rewriteStartupLog(e); });}- async launchPersistentContext(progress: Progress, userDataDir: string, options: channels.BrowserTypeLaunchPersistentContextOptions & { cdpPort?: number, internalIgnoreHTTPSErrors?: boolean, socksProxyPort?: number }): Promise<BrowserContext> {+ async launchPersistentContext(progress: Progress, userDataDir: string, options: channels.BrowserTypeLaunchPersistentContextOptions & { internalIgnoreHTTPSErrors?: boolean, socksProxyPort?: number }): Promise<BrowserContext> {const launchOptions = this._validateLaunchOptions(options);// Note: Any initial TLS requests will fail since we rely on the Page/Frames initialize which sets ignoreHTTPSErrors.let clientCertificatesProxy: ClientCertificatesProxy | undefined;@@ -109,7 +109,7 @@ export abstract class BrowserType extends SdkObject {private async _innerLaunch(progress: Progress, options: types.LaunchOptions, persistent: types.BrowserContextOptions | undefined, protocolLogger: types.ProtocolLogger, maybeUserDataDir?: string): Promise<Browser> {options.proxy = options.proxy ? normalizeProxySettings(options.proxy) : undefined;const browserLogsCollector = new RecentLogsCollector();- const { browserProcess, userDataDir, artifactsDir, transport } = await this._launchProcess(progress, options, !!persistent, browserLogsCollector, maybeUserDataDir);+ const { browserProcess, userDataDir, artifactsDir, transport, wsEndpoint } = await this._launchProcess(progress, options, !!persistent, browserLogsCollector, maybeUserDataDir);try {if ((options as any).__testHookBeforeCreateBrowser)await progress.race((options as any).__testHookBeforeCreateBrowser());@@ -128,7 +128,7 @@ export abstract class BrowserType extends SdkObject {proxy: options.proxy,protocolLogger,browserLogsCollector,- wsEndpoint: transport instanceof WebSocketTransport ? transport.wsEndpoint : undefined,+ wsEndpoint,originalLaunchOptions: options,userDataDir: persistent ? userDataDir : undefined,};@@ -198,7 +198,7 @@ export abstract class BrowserType extends SdkObject {return { executable, browserArguments, userDataDir, artifactsDir, tempDirectories };}- private async _launchProcess(progress: Progress, options: types.LaunchOptions, isPersistent: boolean, browserLogsCollector: RecentLogsCollector, userDataDir?: string): Promise<{ browserProcess: BrowserProcess, artifactsDir: string, userDataDir: string, transport: ConnectionTransport }> {+ private async _launchProcess(progress: Progress, options: types.LaunchOptions, isPersistent: boolean, browserLogsCollector: RecentLogsCollector, userDataDir?: string): Promise<{ browserProcess: BrowserProcess, artifactsDir: string, userDataDir: string, transport: ConnectionTransport, wsEndpoint?: string }> {const {handleSIGINT = true,handleSIGTERM = true,@@ -273,13 +273,13 @@ export abstract class BrowserType extends SdkObject {const updatedLog = this.doRewriteStartupLog(log);throw new Error(`Failed to launch the browser process.\nBrowser logs:\n${updatedLog}`);}- if (options.cdpPort !== undefined || !this.supportsPipeTransport()) {+ if (!this.supportsPipeTransport()) {transport = await WebSocketTransport.connect(progress, wsEndpoint!);} else {const stdio = launchedProcess.stdio as unknown as [NodeJS.ReadableStream, NodeJS.WritableStream, NodeJS.WritableStream, NodeJS.WritableStream, NodeJS.ReadableStream];transport = new PipeTransport(stdio[3], stdio[4]);}- return { browserProcess, artifactsDir: prepared.artifactsDir, userDataDir: prepared.userDataDir, transport };+ return { browserProcess, artifactsDir: prepared.artifactsDir, userDataDir: prepared.userDataDir, transport, wsEndpoint };} catch (error) {await progress.race(closeOrKill(DEFAULT_PLAYWRIGHT_TIMEOUT).catch(() => {}));throw error;diff --git a/packages/playwright-core/src/server/chromium/chromium.ts b/packages/playwright-core/src/server/chromium/chromium.tsindex 9c95feac19..daf7769b5d 100644--- a/packages/playwright-core/src/server/chromium/chromium.ts+++ b/packages/playwright-core/src/server/chromium/chromium.ts@@ -74,7 +74,7 @@ export class Chromium extends BrowserType {return super.launch(progress, options, protocolLogger);}- override async launchPersistentContext(progress: Progress, userDataDir: string, options: channels.BrowserTypeLaunchPersistentContextOptions & { cdpPort?: number, internalIgnoreHTTPSErrors?: boolean, socksProxyPort?: number }): Promise<BrowserContext> {+ override async launchPersistentContext(progress: Progress, userDataDir: string, options: channels.BrowserTypeLaunchPersistentContextOptions & { internalIgnoreHTTPSErrors?: boolean, socksProxyPort?: number }): Promise<BrowserContext> {if (options.channel?.startsWith('bidi-'))return this._bidiChromium.launchPersistentContext(progress, userDataDir, options);return super.launchPersistentContext(progress, userDataDir, options);@@ -343,10 +343,7 @@ export class Chromium extends BrowserType {override async defaultArgs(options: types.LaunchOptions, isPersistent: boolean, userDataDir: string) {const chromeArguments = this._innerDefaultArgs(options);chromeArguments.push(`--user-data-dir=${userDataDir}`);- if (options.cdpPort !== undefined)- chromeArguments.push(`--remote-debugging-port=${options.cdpPort}`);- else- chromeArguments.push('--remote-debugging-pipe');+ chromeArguments.push('--remote-debugging-pipe');if (isPersistent)chromeArguments.push('about:blank');else@@ -363,7 +360,7 @@ export class Chromium extends BrowserType {throw new Error('Playwright manages remote debugging connection itself.');if (args.find(arg => !arg.startsWith('-')))throw new Error('Arguments can not specify page to be opened');- const chromeArguments = [...chromiumSwitches(options.assistantMode, options.channel)];+ const chromeArguments = [...chromiumSwitches()];// See https://issues.chromium.org/issues/40277080chromeArguments.push('--enable-unsafe-swiftshader');@@ -418,7 +415,7 @@ export class Chromium extends BrowserType {}export async function waitForReadyState(options: types.LaunchOptions, browserLogsCollector: RecentLogsCollector): Promise<{ wsEndpoint?: string }> {- if (options.cdpPort === undefined && !options.args?.some(a => a.startsWith('--remote-debugging-port')))+ if (!options.args?.some(a => a.startsWith('--remote-debugging-port')))return {};const result = new ManualPromise<{ wsEndpoint?: string }>();diff --git a/packages/playwright-core/src/server/chromium/chromiumSwitches.ts b/packages/playwright-core/src/server/chromium/chromiumSwitches.tsindex 946630f9ac..af60e7c2b5 100644--- a/packages/playwright-core/src/server/chromium/chromiumSwitches.ts+++ b/packages/playwright-core/src/server/chromium/chromiumSwitches.ts@@ -17,7 +17,7 @@// No dependencies as it is used from the Electron loader.-const disabledFeatures = (assistantMode?: boolean) => [+const disabledFeatures = [// See https://github.com/microsoft/playwright/issues/14047'AvoidUnnecessaryBeforeUnloadCheckSync',// See https://github.com/microsoft/playwright/issues/38568@@ -44,14 +44,13 @@ const disabledFeatures = (assistantMode?: boolean) => ['RenderDocument',// Prevents downloading optimization hints on startup.'OptimizationHints',- assistantMode ? 'AutomationControlled' : '',// Disables forced sign-in in Edge.'msForceBrowserSignIn',// Disables updating the preferred version in LaunchServices preferences on mac.'msEdgeUpdateLaunchServicesPreferredVersion',].filter(Boolean);-export const chromiumSwitches = (assistantMode?: boolean, channel?: string, android?: boolean) => [+export const chromiumSwitches = (options?: { android?: boolean }) => ['--disable-field-trial-config', // https://source.chromium.org/chromium/chromium/src/+/main:testing/variations/README.md'--disable-background-networking','--disable-background-timer-throttling',@@ -66,7 +65,7 @@ export const chromiumSwitches = (assistantMode?: boolean, channel?: string, andr'--disable-dev-shm-usage','--disable-edgeupdater', // Disables Edge-specific updater on mac.'--disable-extensions',- '--disable-features=' + disabledFeatures(assistantMode).join(','),+ '--disable-features=' + disabledFeatures.join(','),process.env.PLAYWRIGHT_LEGACY_SCREENSHOT ? '' : '--enable-features=CDPScreenshotNewSurface','--allow-pre-commit-input','--disable-hang-monitor',@@ -88,12 +87,11 @@ export const chromiumSwitches = (assistantMode?: boolean, channel?: string, andr'--unsafely-disable-devtools-self-xss-warnings',// Edge can potentially restart on Windows (msRelaunchNoCompatLayer) which looses its file descriptors (stdout/stderr) and CDP (3/4). Disable until fixed upstream.'--edge-skip-compat-layer-relaunch',- assistantMode ? '' : '--enable-automation',// This disables Chrome for Testing infobar that is visible in the persistent context.// The switch is ignored everywhere else, including Chromium/Chrome/Edge.'--disable-infobars',// Less annoying popups.'--disable-search-engine-choice-screen',// Prevents the "three dots" menu crash in IdentityManager::HasPrimaryAccount for ephemeral contexts.- android ? '' : '--disable-sync',+ options?.android ? '' : '--disable-sync',].filter(Boolean);diff --git a/packages/playwright-core/src/server/firefox/firefox.ts b/packages/playwright-core/src/server/firefox/firefox.tsindex d469a67c5f..14c43a327c 100644--- a/packages/playwright-core/src/server/firefox/firefox.ts+++ b/packages/playwright-core/src/server/firefox/firefox.ts@@ -47,7 +47,7 @@ export class Firefox extends BrowserType {return super.launch(progress, options, protocolLogger);}- override async launchPersistentContext(progress: Progress, userDataDir: string, options: channels.BrowserTypeLaunchPersistentContextOptions & { cdpPort?: number, internalIgnoreHTTPSErrors?: boolean, socksProxyPort?: number }): Promise<BrowserContext> {+ override async launchPersistentContext(progress: Progress, userDataDir: string, options: channels.BrowserTypeLaunchPersistentContextOptions & { internalIgnoreHTTPSErrors?: boolean, socksProxyPort?: number }): Promise<BrowserContext> {if (options.channel?.startsWith('moz-'))return this._bidiFirefox.launchPersistentContext(progress, userDataDir, options);return super.launchPersistentContext(progress, userDataDir, options);diff --git a/packages/playwright-core/src/server/recorder/recorderApp.ts b/packages/playwright-core/src/server/recorder/recorderApp.tsindex f5538450b5..06d504dc8d 100644--- a/packages/playwright-core/src/server/recorder/recorderApp.ts+++ b/packages/playwright-core/src/server/recorder/recorderApp.ts@@ -214,7 +214,7 @@ export class RecorderApp {persistentContextOptions: {noDefaultViewport: true,headless: !!process.env.PWTEST_CLI_HEADLESS || (isUnderTest() && !headed),- cdpPort: isUnderTest() ? 0 : undefined,+ args: isUnderTest() ? ['--remote-debugging-port=0'] : undefined,handleSIGINT: params.handleSIGINT,executablePath: isChromium ? inspectedContext._browser.options.customExecutablePath : undefined,// Use the same channel as the inspected context to guarantee that the browser is installed.diff --git a/packages/playwright-core/src/server/trace/viewer/traceViewer.ts b/packages/playwright-core/src/server/trace/viewer/traceViewer.tsindex a7d1f70ee5..e9fbf9f51e 100644--- a/packages/playwright-core/src/server/trace/viewer/traceViewer.ts+++ b/packages/playwright-core/src/server/trace/viewer/traceViewer.ts@@ -178,7 +178,7 @@ export async function openTraceViewerApp(url: string, browserName: string, optiowindowSize: { width: 1280, height: 800 },persistentContextOptions: {...options?.persistentContextOptions,- cdpPort: isUnderTest() ? 0 : undefined,+ args: isUnderTest() ? ['--remote-debugging-port=0'] : undefined,headless: !!options?.headless,colorScheme: isUnderTest() ? 'light' : undefined,},diff --git a/packages/playwright-core/src/server/types.ts b/packages/playwright-core/src/server/types.tsindex 8b663e51ef..25c0f81206 100644--- a/packages/playwright-core/src/server/types.ts+++ b/packages/playwright-core/src/server/types.ts@@ -155,9 +155,7 @@ export type NormalizedContinueOverrides = {export type EmulatedSize = { viewport: Size, screen: Size };export type LaunchOptions = Omit<channels.BrowserTypeLaunchParams, 'timeout'> & {- cdpPort?: number,proxyOverride?: ProxySettings,- assistantMode?: boolean,socksProxyPort?: number,};diff --git a/packages/playwright-core/src/tools/mcp/browserFactory.ts b/packages/playwright-core/src/tools/mcp/browserFactory.tsindex cb2cb1e28a..cc048c9bff 100644--- a/packages/playwright-core/src/tools/mcp/browserFactory.ts+++ b/packages/playwright-core/src/tools/mcp/browserFactory.ts@@ -195,9 +195,10 @@ async function createUserDataDir(config: FullConfig, clientInfo: ClientInfo) {}async function injectCdpPort(browserConfig: FullConfig['browser']) {- if (browserConfig.browserName === 'chromium')- // eslint-disable-next-line no-restricted-syntax- (browserConfig.launchOptions as any).cdpPort = await findFreePort();+ if (browserConfig.browserName === 'chromium') {+ browserConfig.launchOptions.args = browserConfig.launchOptions.args ?? [];+ browserConfig.launchOptions.args?.push(`--remote-debugging-port=${await findFreePort()}`);+ }}async function findFreePort(): Promise<number> {diff --git a/packages/playwright-core/src/tools/mcp/config.ts b/packages/playwright-core/src/tools/mcp/config.tsindex 58094def51..974c2fc5e2 100644--- a/packages/playwright-core/src/tools/mcp/config.ts+++ b/packages/playwright-core/src/tools/mcp/config.ts@@ -413,8 +413,6 @@ function mergeConfig(base: MergedConfig, overrides: Config): MergedConfig {launchOptions: {...pickDefined(base.browser?.launchOptions),...pickDefined(overrides.browser?.launchOptions),- // Assistant mode is not a part of the public API.- ...{ assistantMode: true },},contextOptions: {...pickDefined(base.browser?.contextOptions),diff --git a/packages/protocol/src/channels.d.ts b/packages/protocol/src/channels.d.tsindex 5f1e5bd317..8339636c0e 100644--- a/packages/protocol/src/channels.d.ts+++ b/packages/protocol/src/channels.d.ts@@ -902,7 +902,6 @@ export type BrowserTypeLaunchParams = {args?: string[],ignoreAllDefaultArgs?: boolean,ignoreDefaultArgs?: string[],- assistantMode?: boolean,handleSIGINT?: boolean,handleSIGTERM?: boolean,handleSIGHUP?: boolean,@@ -929,7 +928,6 @@ export type BrowserTypeLaunchOptions = {args?: string[],ignoreAllDefaultArgs?: boolean,ignoreDefaultArgs?: string[],- assistantMode?: boolean,handleSIGINT?: boolean,handleSIGTERM?: boolean,handleSIGHUP?: boolean,@@ -958,7 +956,6 @@ export type BrowserTypeLaunchPersistentContextParams = {args?: string[],ignoreAllDefaultArgs?: boolean,ignoreDefaultArgs?: string[],- assistantMode?: boolean,handleSIGINT?: boolean,handleSIGTERM?: boolean,handleSIGHUP?: boolean,@@ -1047,7 +1044,6 @@ export type BrowserTypeLaunchPersistentContextOptions = {args?: string[],ignoreAllDefaultArgs?: boolean,ignoreDefaultArgs?: string[],- assistantMode?: boolean,handleSIGINT?: boolean,handleSIGTERM?: boolean,handleSIGHUP?: boolean,diff --git a/packages/protocol/src/protocol.yml b/packages/protocol/src/protocol.ymlindex a2efffd896..abe1d50420 100644--- a/packages/protocol/src/protocol.yml+++ b/packages/protocol/src/protocol.yml@@ -491,7 +491,6 @@ LaunchOptions:ignoreDefaultArgs:type: array?items: string- assistantMode: boolean?handleSIGINT: boolean?handleSIGTERM: boolean?handleSIGHUP: boolean?diff --git a/tests/library/chromium/chromium.spec.ts b/tests/library/chromium/chromium.spec.tsindex 1433857ead..3c0b2f0b1c 100644--- a/tests/library/chromium/chromium.spec.ts+++ b/tests/library/chromium/chromium.spec.ts@@ -631,11 +631,11 @@ test('should throw when connecting twice to an already running persistent contextest.skip(!!channel?.startsWith('msedge'), 'Edge does not print the ProcessSingleton line');const userDataDir = await createUserDataDir();const browser = await browserType.launchPersistentContext(userDataDir, {- cdpPort: 9222,+ args: ['--remote-debugging-port=9222'],} as any);try {const error = await browserType.launchPersistentContext(userDataDir, {- cdpPort: 9223,+ args: ['--remote-debugging-port=9223'],} as any).catch(e => e);expect(error.message).toContain('This usually means that the profile is already in use by another instance of Chromium.');} finally {diff --git a/tests/library/chromium/oopif.spec.ts b/tests/library/chromium/oopif.spec.tsindex 058bce4a0c..96149d6a88 100644--- a/tests/library/chromium/oopif.spec.ts+++ b/tests/library/chromium/oopif.spec.ts@@ -371,13 +371,13 @@ it('should intercept response body from oopif', async function({ page, browser,expect(await response.text()).toBeTruthy();});-it('should allow to re-connect to OOPIFs with CDP when iframes were there already', async ({ browserType, server, browserMajorVersion }) => {+it('should allow to re-connect to OOPIFs with CDP when iframes were there already', async ({ browserType, server }) => {it.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/36095' });it.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/17656' });- it.skip(browserMajorVersion < 141, 'old chromium does not have TargetInfo.parentFrameId');+ it.skip(!!process.env.PWTEST_CHANNEL, 'Test default channel only');const cdpPort = 10123 + it.info().parallelIndex * 4;- const hostBrowser = await browserType.launch({ cdpPort } as any);+ const hostBrowser = await browserType.launch({ channel: 'chromium', args: ['--remote-debugging-port=' + cdpPort] });const hostPage = await hostBrowser.newPage();await hostPage.goto(server.PREFIX + '/dynamic-oopif.html');diff --git a/tests/mcp/webdriver.spec.ts b/tests/mcp/webdriver.spec.tsdeleted file mode 100644index 99496cb187..0000000000--- a/tests/mcp/webdriver.spec.ts+++ /dev/null@@ -1,40 +0,0 @@-/**- * 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 { test, expect } from './fixtures';--test('do not falsely advertise user agent as a test driver', async ({ client, server, mcpBrowser }) => {- test.skip(mcpBrowser === 'firefox');- test.skip(mcpBrowser === 'webkit');- server.setRoute('/', (req, res) => {- res.writeHead(200, { 'Content-Type': 'text/html' });- res.end(`- <body></body>- <script>- document.body.textContent = 'webdriver: ' + navigator.webdriver;- </script>- `);- });-- expect(await client.callTool({- name: 'browser_navigate',- arguments: {- url: server.PREFIX,- },- })).toHaveResponse({- snapshot: expect.stringContaining(`webdriver: false`),- });-});