Skip to content

chore: use given cdp port for communicating chrome #35759

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 8, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/playwright-core/src/protocol/validator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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({
Expand Down Expand Up @@ -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,
Expand Down
4 changes: 2 additions & 2 deletions packages/playwright-core/src/server/browserType.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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');
Expand Down Expand Up @@ -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];
Expand Down
6 changes: 3 additions & 3 deletions packages/playwright-core/src/server/chromium/chromium.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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,
},
Expand Down
2 changes: 1 addition & 1 deletion packages/playwright-core/src/server/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
};
Expand Down
8 changes: 4 additions & 4 deletions packages/protocol/src/channels.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -967,7 +967,7 @@ export type BrowserTypeLaunchParams = {
tracesDir?: string,
chromiumSandbox?: boolean,
firefoxUserPrefs?: any,
webSocketPort?: number,
cdpPort?: number,
slowMo?: number,
};
export type BrowserTypeLaunchOptions = {
Expand All @@ -994,7 +994,7 @@ export type BrowserTypeLaunchOptions = {
tracesDir?: string,
chromiumSandbox?: boolean,
firefoxUserPrefs?: any,
webSocketPort?: number,
cdpPort?: number,
slowMo?: number,
};
export type BrowserTypeLaunchResult = {
Expand Down Expand Up @@ -1024,7 +1024,7 @@ export type BrowserTypeLaunchPersistentContextParams = {
tracesDir?: string,
chromiumSandbox?: boolean,
firefoxUserPrefs?: any,
webSocketPort?: number,
cdpPort?: number,
noDefaultViewport?: boolean,
viewport?: {
width: number,
Expand Down Expand Up @@ -1107,7 +1107,7 @@ export type BrowserTypeLaunchPersistentContextOptions = {
tracesDir?: string,
chromiumSandbox?: boolean,
firefoxUserPrefs?: any,
webSocketPort?: number,
cdpPort?: number,
noDefaultViewport?: boolean,
viewport?: {
width: number,
Expand Down
2 changes: 1 addition & 1 deletion packages/protocol/src/protocol.yml
Original file line number Diff line number Diff line change
Expand Up @@ -496,7 +496,7 @@ LaunchOptions:
tracesDir: string?
chromiumSandbox: boolean?
firefoxUserPrefs: json?
webSocketPort: number?
cdpPort: number?


ContextOptions:
Expand Down
Loading