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: browser._launchServer (#37031)
Simon Knott3fdbc0623074
diff --git a/packages/playwright-core/src/browserServerImpl.ts b/packages/playwright-core/src/browserServerImpl.tsindex 7ecc0bfc6d..c789991584 100644--- a/packages/playwright-core/src/browserServerImpl.ts+++ b/packages/playwright-core/src/browserServerImpl.ts@@ -26,7 +26,7 @@ import * as validatorPrimitives from './protocol/validatorPrimitives';import { ProgressController } from './server/progress';import type { BrowserServer, BrowserServerLauncher } from './client/browserType';-import type { LaunchServerOptions, Logger, Env } from './client/types';+import type { LaunchOptions, LaunchServerOptions, Logger, Env } from './client/types';import type { ProtocolLogger } from './server/types';import type { WebSocketEventEmitter } from './utilsBundle';import type { Browser } from './server/browser';@@ -38,7 +38,7 @@ export class BrowserServerLauncherImpl implements BrowserServerLauncher {this._browserName = browserName;}- async launchServer(options: LaunchServerOptions & { _sharedBrowser?: boolean, _userDataDir?: string } = {}): Promise<BrowserServer> {+ async launchServer(options: LaunchOptions & LaunchServerOptions & { _userDataDir?: string } = {}): Promise<BrowserServer> {const playwright = createPlaywright({ sdkLanguage: 'javascript', isServer: true });// 1. Pre-launch the browserconst metadata = { id: '', startTime: 0, endTime: 0, type: 'Internal', method: '', params: {}, log: [], internal: true };@@ -78,10 +78,14 @@ export class BrowserServerLauncherImpl implements BrowserServerLauncher {throw e;}+ return this.launchServerOnExistingBrowser(browser, options);+ }++ async launchServerOnExistingBrowser(browser: Browser, options: LaunchServerOptions): Promise<BrowserServer> {const path = options.wsPath ? (options.wsPath.startsWith('/') ? options.wsPath : `/${options.wsPath}`) : `/${createGuid()}`;// 2. Start the server- const server = new PlaywrightServer({ mode: options._sharedBrowser ? 'launchServerShared' : 'launchServer', path, maxConnections: Infinity, preLaunchedBrowser: browser });+ const server = new PlaywrightServer({ mode: options._sharedBrowser ? 'launchServerShared' : 'launchServer', path, maxConnections: Infinity, preLaunchedBrowser: browser, debugController: options._debugController });const wsEndpoint = await server.listen(options.port, options.host);// 3. Return the BrowserServer interfacediff --git a/packages/playwright-core/src/client/browser.ts b/packages/playwright-core/src/client/browser.tsindex 80d2ff2fb9..d112e88443 100644--- a/packages/playwright-core/src/client/browser.ts+++ b/packages/playwright-core/src/client/browser.ts@@ -24,7 +24,7 @@ import { mkdirIfNeeded } from './fileUtils';import type { BrowserType } from './browserType';import type { Page } from './page';-import type { BrowserContextOptions, LaunchOptions, Logger } from './types';+import type { BrowserContextOptions, LaunchOptions, LaunchServerOptions, Logger } from './types';import type * as api from '../../types/types';import type * as channels from '@protocol/channels';@@ -146,6 +146,17 @@ export class Browser extends ChannelOwner<channels.BrowserChannel> implements apreturn CDPSession.from((await this._channel.newBrowserCDPSession()).session);}+ async _launchServer(options: LaunchServerOptions = {}) {+ const serverLauncher = this._browserType._serverLauncher;+ const browserImpl = this._connection.toImpl?.(this);+ if (!serverLauncher || !browserImpl)+ throw new Error('Launching server is not supported');+ return await serverLauncher.launchServerOnExistingBrowser(browserImpl, {+ _sharedBrowser: true,+ ...options,+ });+ }+async startTracing(page?: Page, options: { path?: string; screenshots?: boolean; categories?: string[]; } = {}) {this._path = options.path;await this._channel.startTracing({ ...options, page: page ? page._channel : undefined });diff --git a/packages/playwright-core/src/client/browserType.ts b/packages/playwright-core/src/client/browserType.tsindex af99f15dc7..c0491a0715 100644--- a/packages/playwright-core/src/client/browserType.ts+++ b/packages/playwright-core/src/client/browserType.ts@@ -31,9 +31,11 @@ import type { ConnectOptions, LaunchOptions, LaunchPersistentContextOptions, Lauimport type * as api from '../../types/types';import type * as channels from '@protocol/channels';import type { ChildProcess } from 'child_process';+import type { Browser as BrowserImpl } from '../server/browser';export interface BrowserServerLauncher {- launchServer(options?: LaunchServerOptions): Promise<api.BrowserServer>;+ launchServer(options?: LaunchOptions & LaunchServerOptions): Promise<api.BrowserServer>;+ launchServerOnExistingBrowser(browser: BrowserImpl, options?: LaunchServerOptions): Promise<api.BrowserServer>;}// This is here just for api generation and checking.diff --git a/packages/playwright-core/src/client/types.ts b/packages/playwright-core/src/client/types.tsindex 193903fb80..bcdf728423 100644--- a/packages/playwright-core/src/client/types.ts+++ b/packages/playwright-core/src/client/types.ts@@ -105,10 +105,12 @@ export type ConnectOptions = {timeout?: number,logger?: Logger,};-export type LaunchServerOptions = LaunchOptions & {+export type LaunchServerOptions = {host?: string,port?: number,wsPath?: string,+ _debugController?: boolean;+ _sharedBrowser?: boolean;};export type LaunchAndroidServerOptions = {diff --git a/packages/playwright-core/src/remote/playwrightServer.ts b/packages/playwright-core/src/remote/playwrightServer.tsindex a22ec51bd3..0f5629d7d6 100644--- a/packages/playwright-core/src/remote/playwrightServer.ts+++ b/packages/playwright-core/src/remote/playwrightServer.ts@@ -39,6 +39,7 @@ type ServerOptions = {preLaunchedBrowser?: Browser;preLaunchedAndroidDevice?: AndroidDevice;preLaunchedSocksProxy?: SocksProxy;+ debugController?: boolean;};export class PlaywrightServer {@@ -106,6 +107,19 @@ export class PlaywrightServer {const allowFSPaths = isExtension;launchOptions = filterLaunchOptions(launchOptions, allowFSPaths);+ if (url.searchParams.has('debug-controller')) {+ if (!(this._options.debugController || isExtension))+ throw new Error('Debug controller is not enabled');+ return new PlaywrightConnection(+ controllerSemaphore,+ ws,+ true,+ this._playwright,+ async () => { throw new Error('shouldnt be used'); },+ id,+ );+ }+if (isExtension) {const connectFilter = url.searchParams.get('connect');if (connectFilter) {@@ -121,16 +135,6 @@ export class PlaywrightServer {);}- if (url.searchParams.has('debug-controller')) {- return new PlaywrightConnection(- controllerSemaphore,- ws,- true,- this._playwright,- async () => { throw new Error('shouldnt be used'); },- id,- );- }return new PlaywrightConnection(reuseBrowserSemaphore,ws,diff --git a/packages/playwright-core/src/server/utils/wsServer.ts b/packages/playwright-core/src/server/utils/wsServer.tsindex 95fdd2f72c..16878bdaf9 100644--- a/packages/playwright-core/src/server/utils/wsServer.ts+++ b/packages/playwright-core/src/server/utils/wsServer.ts@@ -106,8 +106,13 @@ export class WSServer {const url = new URL('http://localhost' + (request.url || ''));const id = String(++lastConnectionId);debugLogger.log('server', `[${id}] serving connection: ${request.url}`);- const connection = this._delegate.onConnection(request, url, ws, id);- (ws as any)[kConnectionSymbol] = connection;+ try {+ const connection = this._delegate.onConnection(request, url, ws, id);+ (ws as any)[kConnectionSymbol] = connection;+ } catch (error) {+ debugLogger.log('server', `[${id}] connection error: ${error}`);+ ws.close(1011, String(error));+ }});return wsEndpoint;diff --git a/tests/config/debugControllerBackend.ts b/tests/config/debugControllerBackend.tsindex 9f67d44e50..5b927e53ca 100644--- a/tests/config/debugControllerBackend.ts+++ b/tests/config/debugControllerBackend.ts@@ -153,6 +153,8 @@ export class Backend extends EventEmitter {}private _send(method: string, params: any = {}): Promise<any> {+ if (this._transport.isClosed())+ throw new Error('Transport is closed');return new Promise((fulfill, reject) => {const id = ++Backend._lastId;const command = { id, guid: 'DebugController', method, params, metadata: {} };diff --git a/tests/library/browsertype-connect.spec.ts b/tests/library/browsertype-connect.spec.tsindex acd6d7d47d..a94a95a57f 100644--- a/tests/library/browsertype-connect.spec.ts+++ b/tests/library/browsertype-connect.spec.ts@@ -1046,6 +1046,19 @@ test.describe('launchServer only', () => {const browser = await connect(remoteServer.wsEndpoint()) as any;await expect(browser._parent.launch({ timeout: 0 })).rejects.toThrowError('Launching more browsers is not allowed.');});++ test('should work with existing browser', async ({ connect, browserType }) => {+ // can't use browser fixture because it's shared across the worker, launching a server on that would infect other tests+ const browser = await browserType.launch();+ const page = await browser.newPage();+ await page.setContent('hello world');+ const server = await (browser as any)._launchServer();+ const secondBrowser = await connect(server.wsEndpoint());+ const secondPage = secondBrowser.contexts()[0].pages()[0];+ expect(await secondPage.content()).toContain('hello world');+ await server.close();+ await browser.close();+ });});test('should refuse connecting when versions do not match', async ({ connect, childProcess }) => {diff --git a/tests/library/debug-controller.spec.ts b/tests/library/debug-controller.spec.tsindex 4a67633504..b635f80ddd 100644--- a/tests/library/debug-controller.spec.ts+++ b/tests/library/debug-controller.spec.ts@@ -360,3 +360,32 @@ test('should report error in aria template', async ({ backend }) => {const error = await backend.highlight({ ariaTemplate: `- button "Submit` }).catch(e => e);expect(error.message).toContain('Unterminated string:');});++test('should work with browser._launchServer', async ({ browser }) => {+ const server = await (browser as any)._launchServer({ _debugController: true });++ const backend = new Backend();+ const connectionString = new URL(server.wsEndpoint());+ connectionString.searchParams.set('debug-controller', '');+ await backend.connect(connectionString.toString());+ await backend.initialize();+ await backend.channel.setReportStateChanged({ enabled: true });+ const pageCounts: number[] = [];+ backend.channel.on('stateChanged', event => pageCounts.push(event.pageCount));++ const page = await browser.newPage();+ await page.close();+ expect(pageCounts).toEqual([1, 0]);+});++test('should not work with browser._launchServer(_debugController: false)', async ({ browser }) => {+ const server = await (browser as any)._launchServer({ _debugController: false });++ const backend = new Backend();+ const connectionString = new URL(server.wsEndpoint());+ connectionString.searchParams.set('debug-controller', '');+ await expect(async () => {+ await backend.connect(connectionString.toString());+ await backend.initialize();+ }).rejects.toThrow();+});