Skip to content

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

chore: use given cdp port for communicating chrome (#35759)

Pavel Feldman4facda5f2240
diff --git a/packages/playwright-core/src/protocol/validator.ts b/packages/playwright-core/src/protocol/validator.ts
index a172ab90da..361742b8f6 100644
--- a/packages/playwright-core/src/protocol/validator.ts
+++ b/packages/playwright-core/src/protocol/validator.ts
@@ -557,7 +557,7 @@ scheme.BrowserTypeLaunchParams = tObject({
tracesDir: tOptional(tString),
chromiumSandbox: tOptional(tBoolean),
firefoxUserPrefs: tOptional(tAny),
- webSocketPort: tOptional(tNumber),
+ cdpPort: tOptional(tNumber),
slowMo: tOptional(tNumber),
});
scheme.BrowserTypeLaunchResult = tObject({
@@ -587,7 +587,7 @@ scheme.BrowserTypeLaunchPersistentContextParams = tObject({
tracesDir: tOptional(tString),
chromiumSandbox: tOptional(tBoolean),
firefoxUserPrefs: tOptional(tAny),
- webSocketPort: tOptional(tNumber),
+ cdpPort: tOptional(tNumber),
noDefaultViewport: tOptional(tBoolean),
viewport: tOptional(tObject({
width: tNumber,
diff --git a/packages/playwright-core/src/server/browserType.ts b/packages/playwright-core/src/server/browserType.ts
index d6f644d5c9..37388bfb97 100644
--- a/packages/playwright-core/src/server/browserType.ts
+++ b/packages/playwright-core/src/server/browserType.ts
@@ -95,7 +95,7 @@ export abstract class BrowserType extends SdkObject {
return browser;
}
- async launchPersistentContext(metadata: CallMetadata, userDataDir: string, options: channels.BrowserTypeLaunchPersistentContextOptions & { webSocketPort?: number, internalIgnoreHTTPSErrors?: boolean }): Promise<BrowserContext> {
+ async launchPersistentContext(metadata: CallMetadata, userDataDir: string, options: channels.BrowserTypeLaunchPersistentContextOptions & { cdpPort?: number, internalIgnoreHTTPSErrors?: boolean }): Promise<BrowserContext> {
const launchOptions = this._validateLaunchOptions(options);
const controller = new ProgressController(metadata, this);
controller.setLogName('browser');
@@ -271,7 +271,7 @@ export abstract class BrowserType extends SdkObject {
};
progress.cleanupWhenAborted(() => closeOrKill(progress.timeUntilDeadline()));
const wsEndpoint = (await readyState?.waitUntilReady())?.wsEndpoint;
- if (options.webSocketPort !== undefined || !this.supportsPipeTransport()) {
+ if (options.cdpPort !== 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];
diff --git a/packages/playwright-core/src/server/chromium/chromium.ts b/packages/playwright-core/src/server/chromium/chromium.ts
index bc46d05f27..b3d0fca333 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.webSocketPort !== undefined)
- chromeArguments.push(`--remote-debugging-port=${options.webSocketPort}`);
+ if (options.cdpPort !== undefined)
+ chromeArguments.push(`--remote-debugging-port=${options.cdpPort}`);
else
chromeArguments.push('--remote-debugging-pipe');
if (isPersistent)
@@ -345,7 +345,7 @@ export class Chromium extends BrowserType {
}
override readyState(options: types.LaunchOptions): BrowserReadyState | undefined {
- if (options.webSocketPort !== undefined || options.args?.some(a => a.startsWith('--remote-debugging-port')))
+ if (options.cdpPort !== 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.ts
index 326dc4fe3b..d14c5b0189 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),
- webSocketPort: isUnderTest() ? 0 : undefined,
+ cdpPort: 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.ts
index 78d0f3d8d1..1549839b7a 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, optio
windowSize: { width: 1280, height: 800 },
persistentContextOptions: {
...options?.persistentContextOptions,
- webSocketPort: isUnderTest() ? 0 : undefined,
+ cdpPort: 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.ts
index 4a21b50e37..8cfdf008ef 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 & {
- webSocketPort?: number,
+ cdpPort?: number,
proxyOverride?: ProxySettings,
assistantMode?: boolean,
};
diff --git a/packages/protocol/src/channels.d.ts b/packages/protocol/src/channels.d.ts
index 464abd5f3c..0b7fa280e6 100644
--- a/packages/protocol/src/channels.d.ts
+++ b/packages/protocol/src/channels.d.ts
@@ -967,7 +967,7 @@ export type BrowserTypeLaunchParams = {
tracesDir?: string,
chromiumSandbox?: boolean,
firefoxUserPrefs?: any,
- webSocketPort?: number,
+ cdpPort?: number,
slowMo?: number,
};
export type BrowserTypeLaunchOptions = {
@@ -994,7 +994,7 @@ export type BrowserTypeLaunchOptions = {
tracesDir?: string,
chromiumSandbox?: boolean,
firefoxUserPrefs?: any,
- webSocketPort?: number,
+ cdpPort?: number,
slowMo?: number,
};
export type BrowserTypeLaunchResult = {
@@ -1024,7 +1024,7 @@ export type BrowserTypeLaunchPersistentContextParams = {
tracesDir?: string,
chromiumSandbox?: boolean,
firefoxUserPrefs?: any,
- webSocketPort?: number,
+ cdpPort?: number,
noDefaultViewport?: boolean,
viewport?: {
width: number,
@@ -1107,7 +1107,7 @@ export type BrowserTypeLaunchPersistentContextOptions = {
tracesDir?: string,
chromiumSandbox?: boolean,
firefoxUserPrefs?: any,
- webSocketPort?: number,
+ cdpPort?: number,
noDefaultViewport?: boolean,
viewport?: {
width: number,
diff --git a/packages/protocol/src/protocol.yml b/packages/protocol/src/protocol.yml
index 605e87d252..94553efd79 100644
--- a/packages/protocol/src/protocol.yml
+++ b/packages/protocol/src/protocol.yml
@@ -496,7 +496,7 @@ LaunchOptions:
tracesDir: string?
chromiumSandbox: boolean?
firefoxUserPrefs: json?
- webSocketPort: number?
+ cdpPort: number?
ContextOptions: