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: normalize remote pipe name handling (#39546)
Pavel Feldman0b7635ee98ab
diff --git a/docs/src/api/class-android.md b/docs/src/api/class-android.mdindex c976c9bba8..ffef68509d 100644--- a/docs/src/api/class-android.md+++ b/docs/src/api/class-android.md@@ -81,9 +81,9 @@ const { _android: android } = require('playwright');This methods attaches Playwright to an existing Android device.Use [`method: Android.launchServer`] to launch a new Android server instance.-### param: Android.connect.wsEndpoint+### param: Android.connect.endpoint* since: v1.28-- `wsEndpoint` <[string]>+- `endpoint` <[string]>A browser websocket endpoint to connect to.diff --git a/docs/src/api/class-browsertype.md b/docs/src/api/class-browsertype.mdindex ccb2af7cb7..fa7a0b05f7 100644--- a/docs/src/api/class-browsertype.md+++ b/docs/src/api/class-browsertype.md@@ -95,9 +95,9 @@ This method attaches Playwright to an existing browser instance created via `BroThe major and minor version of the Playwright instance that connects needs to match the version of Playwright that launches the browser (1.2.3 → is compatible with 1.2.x).:::-### param: BrowserType.connect.wsEndpoint+### param: BrowserType.connect.endpoint* since: v1.10-- `wsEndpoint` <[string]>+- `endpoint` <[string]>A Playwright browser websocket endpoint to connect to. You obtain this endpoint via `BrowserServer.wsEndpoint`.diff --git a/packages/playwright-client/types/types.d.ts b/packages/playwright-client/types/types.d.tsindex 3089d164b4..815eb462af 100644--- a/packages/playwright-client/types/types.d.ts+++ b/packages/playwright-client/types/types.d.ts@@ -15169,9 +15169,9 @@ export interface BrowserType<Unused = {}> {* **NOTE** Connecting over the Chrome DevTools Protocol is only supported for Chromium-based browsers.** **NOTE** This connection is significantly lower fidelity than the Playwright protocol connection via- * [browserType.connect(wsEndpoint[, options])](https://playwright.dev/docs/api/class-browsertype#browser-type-connect).+ * [browserType.connect(endpoint[, options])](https://playwright.dev/docs/api/class-browsertype#browser-type-connect).* If you are experiencing issues or attempting to use advanced functionality, you probably want to use- * [browserType.connect(wsEndpoint[, options])](https://playwright.dev/docs/api/class-browsertype#browser-type-connect).+ * [browserType.connect(endpoint[, options])](https://playwright.dev/docs/api/class-browsertype#browser-type-connect).** **Usage***@@ -15199,9 +15199,9 @@ export interface BrowserType<Unused = {}> {* **NOTE** Connecting over the Chrome DevTools Protocol is only supported for Chromium-based browsers.** **NOTE** This connection is significantly lower fidelity than the Playwright protocol connection via- * [browserType.connect(wsEndpoint[, options])](https://playwright.dev/docs/api/class-browsertype#browser-type-connect).+ * [browserType.connect(endpoint[, options])](https://playwright.dev/docs/api/class-browsertype#browser-type-connect).* If you are experiencing issues or attempting to use advanced functionality, you probably want to use- * [browserType.connect(wsEndpoint[, options])](https://playwright.dev/docs/api/class-browsertype#browser-type-connect).+ * [browserType.connect(endpoint[, options])](https://playwright.dev/docs/api/class-browsertype#browser-type-connect).** **Usage***@@ -15222,7 +15222,7 @@ export interface BrowserType<Unused = {}> {* **NOTE** The major and minor version of the Playwright instance that connects needs to match the version of* Playwright that launches the browser (1.2.3 → is compatible with 1.2.x).*- * @param wsEndpoint A Playwright browser websocket endpoint to connect to. You obtain this endpoint via `BrowserServer.wsEndpoint`.+ * @param endpoint A Playwright browser websocket endpoint to connect to. You obtain this endpoint via `BrowserServer.wsEndpoint`.* @param options*/connect(wsEndpoint: string, options?: ConnectOptions): Promise<Browser>;@@ -15238,7 +15238,7 @@ export interface BrowserType<Unused = {}> {* **NOTE** The major and minor version of the Playwright instance that connects needs to match the version of* Playwright that launches the browser (1.2.3 → is compatible with 1.2.x).*- * @param wsEndpoint A Playwright browser websocket endpoint to connect to. You obtain this endpoint via `BrowserServer.wsEndpoint`.+ * @param endpoint A Playwright browser websocket endpoint to connect to. You obtain this endpoint via `BrowserServer.wsEndpoint`.* @param options*/connect(options: ConnectOptions & { wsEndpoint?: string }): Promise<Browser>;@@ -15819,7 +15819,7 @@ export interface BrowserType<Unused = {}> {/*** Returns the browser app instance. You can connect to it via- * [browserType.connect(wsEndpoint[, options])](https://playwright.dev/docs/api/class-browsertype#browser-type-connect),+ * [browserType.connect(endpoint[, options])](https://playwright.dev/docs/api/class-browsertype#browser-type-connect),* which requires the major/minor client/server version to match (1.2.3 → is compatible with 1.2.x).** **Usage**@@ -16818,10 +16818,10 @@ export interface Android {* This methods attaches Playwright to an existing Android device. Use* [android.launchServer([options])](https://playwright.dev/docs/api/class-android#android-launch-server) to launch a* new Android server instance.- * @param wsEndpoint A browser websocket endpoint to connect to.+ * @param endpoint A browser websocket endpoint to connect to.* @param options*/- connect(wsEndpoint: string, options?: {+ connect(endpoint: string, options?: {/*** Additional HTTP headers to be sent with web socket connect request. Optional.*/@@ -19103,7 +19103,7 @@ export interface BrowserServer {* Browser websocket url.** Browser websocket endpoint which can be used as an argument to- * [browserType.connect(wsEndpoint[, options])](https://playwright.dev/docs/api/class-browsertype#browser-type-connect)+ * [browserType.connect(endpoint[, options])](https://playwright.dev/docs/api/class-browsertype#browser-type-connect)* to establish connection to the browser.** Note that if the listen `host` option in `launchServer` options is not specified, localhost will be output anyway,diff --git a/packages/playwright-core/src/client/android.ts b/packages/playwright-core/src/client/android.tsindex 834a30bbe1..8e4c900b51 100644--- a/packages/playwright-core/src/client/android.ts+++ b/packages/playwright-core/src/client/android.ts@@ -66,11 +66,11 @@ export class Android extends ChannelOwner<channels.AndroidChannel> implements apreturn await this._serverLauncher.launchServer(options);}- async connect(wsEndpoint: string, options: Parameters<api.Android['connect']>[1] = {}): Promise<api.AndroidDevice> {+ async connect(endpoint: string, options: Parameters<api.Android['connect']>[1] = {}): Promise<api.AndroidDevice> {return await this._wrapApiCall(async () => {const deadline = options.timeout ? monotonicTime() + options.timeout : 0;const headers = { 'x-playwright-browser': 'android', ...options.headers };- const connectParams: channels.LocalUtilsConnectParams = { wsEndpoint, headers, slowMo: options.slowMo, timeout: options.timeout || 0 };+ const connectParams: channels.LocalUtilsConnectParams = { endpoint, headers, slowMo: options.slowMo, timeout: options.timeout || 0 };const connection = await connectOverWebSocket(this._connection, connectParams);let device: AndroidDevice;diff --git a/packages/playwright-core/src/client/browserType.ts b/packages/playwright-core/src/client/browserType.tsindex e6ae29ca8c..44da774a51 100644--- a/packages/playwright-core/src/client/browserType.ts+++ b/packages/playwright-core/src/client/browserType.ts@@ -122,13 +122,12 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> imple}connect(options: api.ConnectOptions & { wsEndpoint: string }): Promise<Browser>;- connect(options: api.ConnectOptions & { pipeName: string }): Promise<Browser>;- connect(wsEndpoint: string, options?: api.ConnectOptions): Promise<Browser>;- async connect(optionsOrWsEndpoint: string | (api.ConnectOptions & { wsEndpoint?: string, pipeName?: string }), options?: api.ConnectOptions): Promise<Browser>{- if (typeof optionsOrWsEndpoint === 'string')- return await this._connect({ ...options, wsEndpoint: optionsOrWsEndpoint });- assert(optionsOrWsEndpoint.wsEndpoint || optionsOrWsEndpoint.pipeName, 'Either options.wsEndpoint or options.pipeName is required');- return await this._connect(optionsOrWsEndpoint);+ connect(endpoint: string, options?: api.ConnectOptions): Promise<Browser>;+ async connect(optionsOrEndpoint: string | (api.ConnectOptions & { wsEndpoint?: string, pipeName?: string }), options?: api.ConnectOptions): Promise<Browser>{+ if (typeof optionsOrEndpoint === 'string')+ return await this._connect({ ...options, endpoint: optionsOrEndpoint });+ assert(optionsOrEndpoint.wsEndpoint, 'options.wsEndpoint is required');+ return await this._connect(optionsOrEndpoint);}async _connect(params: ConnectOptions): Promise<Browser> {@@ -137,10 +136,9 @@ export class BrowserType extends ChannelOwner<channels.BrowserTypeChannel> impleconst deadline = params.timeout ? monotonicTime() + params.timeout : 0;const headers = { 'x-playwright-browser': this.name(), ...params.headers };const connectParams: channels.LocalUtilsConnectParams = {- wsEndpoint: params.wsEndpoint,- pipeName: params.pipeName,+ endpoint: params.endpoint!,headers,- exposeNetwork: params.exposeNetwork ?? params._exposeNetwork,+ exposeNetwork: params.exposeNetwork,slowMo: params.slowMo,timeout: params.timeout || 0,};diff --git a/packages/playwright-core/src/client/types.ts b/packages/playwright-core/src/client/types.tsindex 920cc3ea98..d926e9f8cc 100644--- a/packages/playwright-core/src/client/types.ts+++ b/packages/playwright-core/src/client/types.ts@@ -96,14 +96,12 @@ export type LaunchOptions = Omit<channels.BrowserTypeLaunchOptions, 'ignoreAllDeexport type LaunchPersistentContextOptions = Omit<LaunchOptions & BrowserContextOptions, 'storageState'>;export type ConnectOptions = {- wsEndpoint?: string,- pipeName?: string,+ endpoint?: string;headers?: { [key: string]: string; };- exposeNetwork?: string,- _exposeNetwork?: string,- slowMo?: number,- timeout?: number,- logger?: Logger,+ exposeNetwork?: string;+ slowMo?: number;+ timeout?: number;+ logger?: Logger;};export type LaunchServerOptions = LaunchOptions & {host?: string,diff --git a/packages/playwright-core/src/client/webSocket.ts b/packages/playwright-core/src/client/webSocket.tsindex 0e56a2401b..7afc749573 100644--- a/packages/playwright-core/src/client/webSocket.ts+++ b/packages/playwright-core/src/client/webSocket.ts@@ -88,7 +88,7 @@ class WebSocketTransport implements Transport {private _ws: WebSocket | undefined;async connect(params: channels.LocalUtilsConnectParams) {- this._ws = new window.WebSocket(params.wsEndpoint!);+ this._ws = new window.WebSocket(params.endpoint);return [];}diff --git a/packages/playwright-core/src/protocol/validator.ts b/packages/playwright-core/src/protocol/validator.tsindex 5a0f5b36be..2a31b6c521 100644--- a/packages/playwright-core/src/protocol/validator.ts+++ b/packages/playwright-core/src/protocol/validator.ts@@ -314,8 +314,7 @@ scheme.LocalUtilsHarUnzipParams = tObject({});scheme.LocalUtilsHarUnzipResult = tOptional(tObject({}));scheme.LocalUtilsConnectParams = tObject({- wsEndpoint: tOptional(tString),- pipeName: tOptional(tString),+ endpoint: tString,headers: tOptional(tAny),exposeNetwork: tOptional(tString),slowMo: tOptional(tFloat),diff --git a/packages/playwright-core/src/server/dispatchers/localUtilsDispatcher.ts b/packages/playwright-core/src/server/dispatchers/localUtilsDispatcher.tsindex 655aa5df1c..b52b0dd33a 100644--- a/packages/playwright-core/src/server/dispatchers/localUtilsDispatcher.ts+++ b/packages/playwright-core/src/server/dispatchers/localUtilsDispatcher.ts@@ -84,9 +84,9 @@ export class LocalUtilsDispatcher extends Dispatcher<SdkObject, channels.LocalUt}async connect(params: channels.LocalUtilsConnectParams, progress: Progress): Promise<channels.LocalUtilsConnectResult> {- if (params.pipeName)- return await this._connectOverPipe(params, progress);- return await this._connectOverWebSocket(params, progress);+ if (URL.canParse(params.endpoint))+ return await this._connectOverWebSocket(params, progress);+ return await this._connectOverPipe(params, progress);}private async _connectOverWebSocket(params: channels.LocalUtilsConnectParams, progress: Progress): Promise<channels.LocalUtilsConnectResult> {@@ -95,7 +95,7 @@ export class LocalUtilsDispatcher extends Dispatcher<SdkObject, channels.LocalUt'x-playwright-proxy': params.exposeNetwork ?? '',...params.headers,};- const wsEndpoint = await urlToWSEndpoint(progress, params.wsEndpoint!);+ const wsEndpoint = await urlToWSEndpoint(progress, params.endpoint);const transport = await WebSocketTransport.connect(progress, wsEndpoint, { headers: wsHeaders, followRedirects: true, debugLogHeader: 'x-playwright-debug-log' });const socksInterceptor = new SocksInterceptor(transport, params.exposeNetwork, params.socksProxyRedirectPortForTest);@@ -128,7 +128,7 @@ export class LocalUtilsDispatcher extends Dispatcher<SdkObject, channels.LocalUtprivate async _connectOverPipe(params: channels.LocalUtilsConnectParams, progress: Progress): Promise<channels.LocalUtilsConnectResult> {const socket = await new Promise<net.Socket>((resolve, reject) => {- const conn = net.connect(params.pipeName!, () => resolve(conn));+ const conn = net.connect(params.endpoint, () => resolve(conn));conn.on('error', reject);});const transport = new PipeTransport(socket, socket);diff --git a/packages/playwright-core/types/types.d.ts b/packages/playwright-core/types/types.d.tsindex 3089d164b4..815eb462af 100644--- a/packages/playwright-core/types/types.d.ts+++ b/packages/playwright-core/types/types.d.ts@@ -15169,9 +15169,9 @@ export interface BrowserType<Unused = {}> {* **NOTE** Connecting over the Chrome DevTools Protocol is only supported for Chromium-based browsers.** **NOTE** This connection is significantly lower fidelity than the Playwright protocol connection via- * [browserType.connect(wsEndpoint[, options])](https://playwright.dev/docs/api/class-browsertype#browser-type-connect).+ * [browserType.connect(endpoint[, options])](https://playwright.dev/docs/api/class-browsertype#browser-type-connect).* If you are experiencing issues or attempting to use advanced functionality, you probably want to use- * [browserType.connect(wsEndpoint[, options])](https://playwright.dev/docs/api/class-browsertype#browser-type-connect).+ * [browserType.connect(endpoint[, options])](https://playwright.dev/docs/api/class-browsertype#browser-type-connect).** **Usage***@@ -15199,9 +15199,9 @@ export interface BrowserType<Unused = {}> {* **NOTE** Connecting over the Chrome DevTools Protocol is only supported for Chromium-based browsers.** **NOTE** This connection is significantly lower fidelity than the Playwright protocol connection via- * [browserType.connect(wsEndpoint[, options])](https://playwright.dev/docs/api/class-browsertype#browser-type-connect).+ * [browserType.connect(endpoint[, options])](https://playwright.dev/docs/api/class-browsertype#browser-type-connect).* If you are experiencing issues or attempting to use advanced functionality, you probably want to use- * [browserType.connect(wsEndpoint[, options])](https://playwright.dev/docs/api/class-browsertype#browser-type-connect).+ * [browserType.connect(endpoint[, options])](https://playwright.dev/docs/api/class-browsertype#browser-type-connect).** **Usage***@@ -15222,7 +15222,7 @@ export interface BrowserType<Unused = {}> {* **NOTE** The major and minor version of the Playwright instance that connects needs to match the version of* Playwright that launches the browser (1.2.3 → is compatible with 1.2.x).*- * @param wsEndpoint A Playwright browser websocket endpoint to connect to. You obtain this endpoint via `BrowserServer.wsEndpoint`.+ * @param endpoint A Playwright browser websocket endpoint to connect to. You obtain this endpoint via `BrowserServer.wsEndpoint`.* @param options*/connect(wsEndpoint: string, options?: ConnectOptions): Promise<Browser>;@@ -15238,7 +15238,7 @@ export interface BrowserType<Unused = {}> {* **NOTE** The major and minor version of the Playwright instance that connects needs to match the version of* Playwright that launches the browser (1.2.3 → is compatible with 1.2.x).*- * @param wsEndpoint A Playwright browser websocket endpoint to connect to. You obtain this endpoint via `BrowserServer.wsEndpoint`.+ * @param endpoint A Playwright browser websocket endpoint to connect to. You obtain this endpoint via `BrowserServer.wsEndpoint`.* @param options*/connect(options: ConnectOptions & { wsEndpoint?: string }): Promise<Browser>;@@ -15819,7 +15819,7 @@ export interface BrowserType<Unused = {}> {/*** Returns the browser app instance. You can connect to it via- * [browserType.connect(wsEndpoint[, options])](https://playwright.dev/docs/api/class-browsertype#browser-type-connect),+ * [browserType.connect(endpoint[, options])](https://playwright.dev/docs/api/class-browsertype#browser-type-connect),* which requires the major/minor client/server version to match (1.2.3 → is compatible with 1.2.x).** **Usage**@@ -16818,10 +16818,10 @@ export interface Android {* This methods attaches Playwright to an existing Android device. Use* [android.launchServer([options])](https://playwright.dev/docs/api/class-android#android-launch-server) to launch a* new Android server instance.- * @param wsEndpoint A browser websocket endpoint to connect to.+ * @param endpoint A browser websocket endpoint to connect to.* @param options*/- connect(wsEndpoint: string, options?: {+ connect(endpoint: string, options?: {/*** Additional HTTP headers to be sent with web socket connect request. Optional.*/@@ -19103,7 +19103,7 @@ export interface BrowserServer {* Browser websocket url.** Browser websocket endpoint which can be used as an argument to- * [browserType.connect(wsEndpoint[, options])](https://playwright.dev/docs/api/class-browsertype#browser-type-connect)+ * [browserType.connect(endpoint[, options])](https://playwright.dev/docs/api/class-browsertype#browser-type-connect)* to establish connection to the browser.** Note that if the listen `host` option in `launchServer` options is not specified, localhost will be output anyway,diff --git a/packages/playwright/src/index.ts b/packages/playwright/src/index.tsindex 3f4356d15f..72582d06fb 100644--- a/packages/playwright/src/index.ts+++ b/packages/playwright/src/index.ts@@ -106,9 +106,9 @@ const playwrightFixtures: Fixtures<TestFixtures, WorkerFixtures> = ({throw new Error(`Unexpected browserName "${browserName}", must be one of "chromium", "firefox" or "webkit"`);if (connectOptions) {- const browser = await playwright[browserName].connect({+ const browser = await playwright[browserName].connect(connectOptions.wsEndpoint, {...connectOptions,- exposeNetwork: connectOptions.exposeNetwork ?? (connectOptions as any)._exposeNetwork,+ exposeNetwork: connectOptions.exposeNetwork,headers: {// HTTP headers are ASCII only (not UTF-8).'x-playwright-launch-options': jsonStringifyForceASCII(_browserOptions),diff --git a/packages/protocol/src/channels.d.ts b/packages/protocol/src/channels.d.tsindex 5e8c20cf20..ed98799521 100644--- a/packages/protocol/src/channels.d.ts+++ b/packages/protocol/src/channels.d.ts@@ -532,8 +532,7 @@ export type LocalUtilsHarUnzipOptions = {};export type LocalUtilsHarUnzipResult = void;export type LocalUtilsConnectParams = {- wsEndpoint?: string,- pipeName?: string,+ endpoint: string,headers?: any,exposeNetwork?: string,slowMo?: number,@@ -541,8 +540,6 @@ export type LocalUtilsConnectParams = {socksProxyRedirectPortForTest?: number,};export type LocalUtilsConnectOptions = {- wsEndpoint?: string,- pipeName?: string,headers?: any,exposeNetwork?: string,slowMo?: number,diff --git a/packages/protocol/src/protocol.yml b/packages/protocol/src/protocol.ymlindex 344101d69e..a812775aee 100644--- a/packages/protocol/src/protocol.yml+++ b/packages/protocol/src/protocol.yml@@ -706,8 +706,7 @@ LocalUtils:connect:internal: trueparameters:- wsEndpoint: string?- pipeName: string?+ endpoint: stringheaders: json?exposeNetwork: string?slowMo: float?diff --git a/tests/config/remoteServer.ts b/tests/config/remoteServer.tsindex 1e04c0c8db..6d5f0cc452 100644--- a/tests/config/remoteServer.ts+++ b/tests/config/remoteServer.ts@@ -126,7 +126,7 @@ export class RemoteServer implements PlaywrightServer {this._wsEndpoint = await this.out('wsEndpoint');if (remoteServerOptions.url) {- this._browser = await this._browserType.connect({ wsEndpoint: this._wsEndpoint });+ this._browser = await this._browserType.connect(this._wsEndpoint);const page = await this._browser.newPage();await page.goto(remoteServerOptions.url);}diff --git a/tests/library/browser-server.spec.ts b/tests/library/browser-server.spec.tsindex 84b2bacc15..d34e5cdc61 100644--- a/tests/library/browser-server.spec.ts+++ b/tests/library/browser-server.spec.ts@@ -32,7 +32,7 @@ it('should start and stop pipe server', async ({ browserType, browser }) => {pipeName: expect.stringMatching(/browser@.*\.sock/),}));- const browser2 = await (browserType as any).connect(serverInfo);+ const browser2 = await (browserType as any).connect(serverInfo.pipeName);const page = await browser2.newPage();await page.goto('data:text/html,<h1>Hello via pipe</h1>');expect(await page.locator('h1').textContent()).toBe('Hello via pipe');diff --git a/tests/library/browsertype-connect.spec.ts b/tests/library/browsertype-connect.spec.tsindex b3ccee17ab..e146492aad 100644--- a/tests/library/browsertype-connect.spec.ts+++ b/tests/library/browsertype-connect.spec.ts@@ -620,8 +620,7 @@ for (const kind of ['launchServer', 'run-server'] as const) {test('should be able to connect when the wsEndpoint is passed as an option', async ({ browserType, startRemoteServer }) => {const remoteServer = await startRemoteServer(kind);- const browser = await browserType.connect({- wsEndpoint: remoteServer.wsEndpoint(),+ const browser = await browserType.connect(remoteServer.wsEndpoint(), {headers: {'x-playwright-launch-options': JSON.stringify((browserType as any)._playwright._defaultLaunchOptions || {}),},@@ -850,7 +849,7 @@ for (const kind of ['launchServer', 'run-server'] as const) {});const examplePort = 20_000 + testInfo.workerIndex * 3;const remoteServer = await startRemoteServer(kind);- const browser = await connect(remoteServer.wsEndpoint(), { _exposeNetwork: '*' } as any, dummyServerPort);+ const browser = await connect(remoteServer.wsEndpoint(), { exposeNetwork: '*' } as any, dummyServerPort);const page = await browser.newPage();{await page.setContent('empty');diff --git a/tests/library/browsertype-launch-server.spec.ts b/tests/library/browsertype-launch-server.spec.tsindex fed973dde5..cc6490fb27 100644--- a/tests/library/browsertype-launch-server.spec.ts+++ b/tests/library/browsertype-launch-server.spec.ts@@ -66,7 +66,7 @@ it.describe('launch server', () => {it('should provide an error when ws endpoint is incorrect', async ({ browserType }) => {const browserServer = await browserType.launchServer();- const error = await browserType.connect({ wsEndpoint: browserServer.wsEndpoint() + '-foo' }).catch(e => e);+ const error = await browserType.connect(browserServer.wsEndpoint() + '-foo').catch(e => e);await browserServer.close();expect(error.message).toContain('400 Bad Request');});