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: allow running chromium with given ws port internally (#35722)
Pavel Feldman8fdd0943b6f6
diff --git a/packages/playwright-core/src/protocol/validator.ts b/packages/playwright-core/src/protocol/validator.tsindex 8ef6aa850f..4e6f4b379e 100644--- a/packages/playwright-core/src/protocol/validator.ts+++ b/packages/playwright-core/src/protocol/validator.ts@@ -556,6 +556,7 @@ scheme.BrowserTypeLaunchParams = tObject({tracesDir: tOptional(tString),chromiumSandbox: tOptional(tBoolean),firefoxUserPrefs: tOptional(tAny),+ webSocketPort: tOptional(tNumber),slowMo: tOptional(tNumber),});scheme.BrowserTypeLaunchResult = tObject({@@ -584,6 +585,7 @@ scheme.BrowserTypeLaunchPersistentContextParams = tObject({tracesDir: tOptional(tString),chromiumSandbox: tOptional(tBoolean),firefoxUserPrefs: tOptional(tAny),+ webSocketPort: tOptional(tNumber),noDefaultViewport: tOptional(tBoolean),viewport: tOptional(tObject({width: tNumber,diff --git a/packages/playwright-core/src/server/bidi/bidiChromium.ts b/packages/playwright-core/src/server/bidi/bidiChromium.tsindex 37b3dc21c1..640871e44f 100644--- a/packages/playwright-core/src/server/bidi/bidiChromium.ts+++ b/packages/playwright-core/src/server/bidi/bidiChromium.ts@@ -16,7 +16,6 @@import os from 'os';-import { assert } from '../../utils';import { wrapInASCIIBox } from '../utils/ascii';import { BrowserReadyState, BrowserType, kNoXServerRunningError } from '../browserType';import { BidiBrowser } from './bidiBrowser';@@ -34,7 +33,6 @@ import type * as types from '../types';export class BidiChromium extends BrowserType {constructor(parent: SdkObject) {super(parent, 'bidi');- this._useBidi = true;}override async connectToTransport(transport: ConnectionTransport, options: BrowserOptions): Promise<BidiBrowser> {@@ -78,6 +76,10 @@ export class BidiChromium extends BrowserType {transport.send({ method: 'browser.close', params: {}, id: kBrowserCloseMessageId });}+ override supportsPipeTransport(): boolean {+ return false;+ }+override defaultArgs(options: types.LaunchOptions, isPersistent: boolean, userDataDir: string): string[] {const chromeArguments = this._innerDefaultArgs(options);chromeArguments.push(`--user-data-dir=${userDataDir}`);@@ -90,7 +92,6 @@ export class BidiChromium extends BrowserType {}override readyState(options: types.LaunchOptions): BrowserReadyState | undefined {- assert(options.useWebSocket);return new ChromiumReadyState();}diff --git a/packages/playwright-core/src/server/bidi/bidiFirefox.ts b/packages/playwright-core/src/server/bidi/bidiFirefox.tsindex 7af6fd43aa..4a3c027a31 100644--- a/packages/playwright-core/src/server/bidi/bidiFirefox.ts+++ b/packages/playwright-core/src/server/bidi/bidiFirefox.ts@@ -17,7 +17,6 @@import os from 'os';import path from 'path';-import { assert } from '../../utils';import { wrapInASCIIBox } from '../utils/ascii';import { BrowserReadyState, BrowserType, kNoXServerRunningError } from '../browserType';import { BidiBrowser } from './bidiBrowser';@@ -35,7 +34,6 @@ import type * as types from '../types';export class BidiFirefox extends BrowserType {constructor(parent: SdkObject) {super(parent, 'bidi');- this._useBidi = true;}override async connectToTransport(transport: ConnectionTransport, options: BrowserOptions): Promise<BidiBrowser> {@@ -77,6 +75,10 @@ export class BidiFirefox extends BrowserType {transport.send({ method: 'browser.close', params: {}, id: kBrowserCloseMessageId });}+ override supportsPipeTransport(): boolean {+ return false;+ }+override async prepareUserDataDir(options: types.LaunchOptions, userDataDir: string): Promise<void> {await createProfile({path: userDataDir,@@ -100,7 +102,6 @@ export class BidiFirefox extends BrowserType {}override readyState(options: types.LaunchOptions): BrowserReadyState | undefined {- assert(options.useWebSocket);return new FirefoxReadyState();}}diff --git a/packages/playwright-core/src/server/browserType.ts b/packages/playwright-core/src/server/browserType.tsindex 208fb55fdc..d6f644d5c9 100644--- a/packages/playwright-core/src/server/browserType.ts+++ b/packages/playwright-core/src/server/browserType.ts@@ -67,7 +67,6 @@ export abstract class BrowserReadyState {export abstract class BrowserType extends SdkObject {private _name: BrowserName;- _useBidi: boolean = false;constructor(parent: SdkObject, browserName: BrowserName) {super(parent, 'browser-type');@@ -85,8 +84,6 @@ export abstract class BrowserType extends SdkObject {async launch(metadata: CallMetadata, options: types.LaunchOptions, protocolLogger?: types.ProtocolLogger): Promise<Browser> {options = this._validateLaunchOptions(options);- if (this._useBidi)- options.useWebSocket = true;const controller = new ProgressController(metadata, this);controller.setLogName('browser');const browser = await controller.run(progress => {@@ -98,10 +95,8 @@ export abstract class BrowserType extends SdkObject {return browser;}- async launchPersistentContext(metadata: CallMetadata, userDataDir: string, options: channels.BrowserTypeLaunchPersistentContextOptions & { useWebSocket?: boolean, internalIgnoreHTTPSErrors?: boolean }): Promise<BrowserContext> {+ async launchPersistentContext(metadata: CallMetadata, userDataDir: string, options: channels.BrowserTypeLaunchPersistentContextOptions & { webSocketPort?: number, internalIgnoreHTTPSErrors?: boolean }): Promise<BrowserContext> {const launchOptions = this._validateLaunchOptions(options);- if (this._useBidi)- launchOptions.useWebSocket = true;const controller = new ProgressController(metadata, this);controller.setLogName('browser');const browser = await controller.run(async progress => {@@ -156,7 +151,7 @@ export abstract class BrowserType extends SdkObject {proxy: options.proxy,protocolLogger,browserLogsCollector,- wsEndpoint: options.useWebSocket ? (transport as WebSocketTransport).wsEndpoint : undefined,+ wsEndpoint: transport instanceof WebSocketTransport ? transport.wsEndpoint : undefined,originalLaunchOptions: options,};if (persistent)@@ -276,7 +271,7 @@ export abstract class BrowserType extends SdkObject {};progress.cleanupWhenAborted(() => closeOrKill(progress.timeUntilDeadline()));const wsEndpoint = (await readyState?.waitUntilReady())?.wsEndpoint;- if (options.useWebSocket) {+ if (options.webSocketPort !== undefined || !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];@@ -338,6 +333,10 @@ export abstract class BrowserType extends SdkObject {async prepareUserDataDir(options: types.LaunchOptions, userDataDir: string): Promise<void> {}+ supportsPipeTransport(): boolean {+ return true;+ }+getExecutableName(options: types.LaunchOptions): string {return options.channel || this._name;}diff --git a/packages/playwright-core/src/server/chromium/chromium.ts b/packages/playwright-core/src/server/chromium/chromium.tsindex 94c9103cee..756989c662 100644--- a/packages/playwright-core/src/server/chromium/chromium.ts+++ b/packages/playwright-core/src/server/chromium/chromium.ts@@ -276,8 +276,8 @@ export class Chromium extends BrowserType {override defaultArgs(options: types.LaunchOptions, isPersistent: boolean, userDataDir: string): string[] {const chromeArguments = this._innerDefaultArgs(options);chromeArguments.push(`--user-data-dir=${userDataDir}`);- if (options.useWebSocket)- chromeArguments.push('--remote-debugging-port=0');+ if (options.webSocketPort !== undefined)+ chromeArguments.push(`--remote-debugging-port=${options.webSocketPort}`);elsechromeArguments.push('--remote-debugging-pipe');if (isPersistent)@@ -345,7 +345,7 @@ export class Chromium extends BrowserType {}override readyState(options: types.LaunchOptions): BrowserReadyState | undefined {- if (options.useWebSocket || options.args?.some(a => a.startsWith('--remote-debugging-port')))+ if (options.webSocketPort !== undefined || options.args?.some(a => a.startsWith('--remote-debugging-port')))return new ChromiumReadyState();return undefined;}diff --git a/packages/playwright-core/src/server/recorder/recorderApp.ts b/packages/playwright-core/src/server/recorder/recorderApp.tsindex 3b455e6c9f..7a239e643a 100644--- a/packages/playwright-core/src/server/recorder/recorderApp.ts+++ b/packages/playwright-core/src/server/recorder/recorderApp.ts@@ -112,7 +112,7 @@ export class RecorderApp extends EventEmitter implements IRecorderApp {persistentContextOptions: {noDefaultViewport: true,headless: !!process.env.PWTEST_CLI_HEADLESS || (isUnderTest() && !headed),- useWebSocket: isUnderTest(),+ webSocketPort: isUnderTest() ? 0 : undefined,handleSIGINT: recorder.handleSIGINT,executablePath: inspectedContext._browser.options.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 2e4c33819b..78d0f3d8d1 100644--- a/packages/playwright-core/src/server/trace/viewer/traceViewer.ts+++ b/packages/playwright-core/src/server/trace/viewer/traceViewer.ts@@ -174,7 +174,7 @@ export async function openTraceViewerApp(url: string, browserName: string, optiowindowSize: { width: 1280, height: 800 },persistentContextOptions: {...options?.persistentContextOptions,- useWebSocket: isUnderTest(),+ webSocketPort: isUnderTest() ? 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 a8681fd6cf..5593ce8708 100644--- a/packages/playwright-core/src/server/types.ts+++ b/packages/playwright-core/src/server/types.ts@@ -153,7 +153,7 @@ export type NormalizedContinueOverrides = {export type EmulatedSize = { viewport: Size, screen: Size };export type LaunchOptions = channels.BrowserTypeLaunchOptions & {- useWebSocket?: boolean,+ webSocketPort?: number,proxyOverride?: ProxySettings,};diff --git a/packages/protocol/src/channels.d.ts b/packages/protocol/src/channels.d.tsindex 170e76410f..087f1ee562 100644--- a/packages/protocol/src/channels.d.ts+++ b/packages/protocol/src/channels.d.ts@@ -966,6 +966,7 @@ export type BrowserTypeLaunchParams = {tracesDir?: string,chromiumSandbox?: boolean,firefoxUserPrefs?: any,+ webSocketPort?: number,slowMo?: number,};export type BrowserTypeLaunchOptions = {@@ -991,6 +992,7 @@ export type BrowserTypeLaunchOptions = {tracesDir?: string,chromiumSandbox?: boolean,firefoxUserPrefs?: any,+ webSocketPort?: number,slowMo?: number,};export type BrowserTypeLaunchResult = {@@ -1019,6 +1021,7 @@ export type BrowserTypeLaunchPersistentContextParams = {tracesDir?: string,chromiumSandbox?: boolean,firefoxUserPrefs?: any,+ webSocketPort?: number,noDefaultViewport?: boolean,viewport?: {width: number,@@ -1100,6 +1103,7 @@ export type BrowserTypeLaunchPersistentContextOptions = {tracesDir?: string,chromiumSandbox?: boolean,firefoxUserPrefs?: any,+ webSocketPort?: number,noDefaultViewport?: boolean,viewport?: {width: number,diff --git a/packages/protocol/src/protocol.yml b/packages/protocol/src/protocol.ymlindex 481570f6e3..f13b353be6 100644--- a/packages/protocol/src/protocol.yml+++ b/packages/protocol/src/protocol.yml@@ -495,6 +495,7 @@ LaunchOptions:tracesDir: string?chromiumSandbox: boolean?firefoxUserPrefs: json?+ webSocketPort: number?ContextOptions: