Skip to content

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

chore: prevent launching more browsers in server mode (#36353)

Simon Knott50cb8a1ffb50
diff --git a/packages/playwright-core/src/remote/playwrightConnection.ts b/packages/playwright-core/src/remote/playwrightConnection.ts
index 94fe34e7aa..1b56d45698 100644
--- a/packages/playwright-core/src/remote/playwrightConnection.ts
+++ b/packages/playwright-core/src/remote/playwrightConnection.ts
@@ -131,16 +131,13 @@ export class PlaywrightConnection {
const browser = await playwright[browserName as 'chromium'].launch(serverSideCallMetadata(), this._options.launchOptions);
browser.options.sdkLanguage = options.sdkLanguage;
- this._cleanups.push(async () => {
- for (const browser of playwright.allBrowsers())
- await browser.close({ reason: 'Connection terminated' });
- });
+ this._cleanups.push(() => browser.close({ reason: 'Connection terminated' }));
browser.on(Browser.Events.Disconnected, () => {
// Underlying browser did close for some reason - force disconnect the client.
this.close({ code: 1001, reason: 'Browser closed' });
});
- return new PlaywrightDispatcher(scope, playwright, { socksProxy: ownedSocksProxy, preLaunchedBrowser: browser });
+ return new PlaywrightDispatcher(scope, playwright, { socksProxy: ownedSocksProxy, preLaunchedBrowser: browser, denyLaunch: true, });
}
private async _initPreLaunchedBrowserMode(scope: RootDispatcher, options: channels.RootInitializeParams) {
@@ -161,6 +158,7 @@ export class PlaywrightConnection {
socksProxy: this._preLaunched.socksProxy,
preLaunchedBrowser: browser,
sharedBrowser: this._options.sharedBrowser,
+ denyLaunch: true,
});
// In pre-launched mode, keep only the pre-launched browser.
for (const b of playwright.allBrowsers()) {
@@ -179,7 +177,7 @@ export class PlaywrightConnection {
// Underlying browser did close for some reason - force disconnect the client.
this.close({ code: 1001, reason: 'Android device disconnected' });
});
- const playwrightDispatcher = new PlaywrightDispatcher(scope, playwright, { preLaunchedAndroidDevice: androidDevice });
+ const playwrightDispatcher = new PlaywrightDispatcher(scope, playwright, { preLaunchedAndroidDevice: androidDevice, denyLaunch: true });
this._cleanups.push(() => playwrightDispatcher.cleanup());
return playwrightDispatcher;
}
@@ -241,7 +239,7 @@ export class PlaywrightConnection {
}
});
- const playwrightDispatcher = new PlaywrightDispatcher(scope, playwright, { preLaunchedBrowser: browser });
+ const playwrightDispatcher = new PlaywrightDispatcher(scope, playwright, { preLaunchedBrowser: browser, denyLaunch: true });
return playwrightDispatcher;
}
diff --git a/packages/playwright-core/src/remote/playwrightServer.ts b/packages/playwright-core/src/remote/playwrightServer.ts
index e823f8ce87..44b204a962 100644
--- a/packages/playwright-core/src/remote/playwrightServer.ts
+++ b/packages/playwright-core/src/remote/playwrightServer.ts
@@ -16,7 +16,6 @@
import { PlaywrightConnection } from './playwrightConnection';
import { createPlaywright } from '../server/playwright';
-import { debugLogger } from '../server/utils/debugLogger';
import { Semaphore } from '../utils/isomorphic/semaphore';
import { DEFAULT_PLAYWRIGHT_LAUNCH_TIMEOUT } from '../utils/isomorphic/time';
import { WSServer } from '../server/utils/wsServer';
@@ -132,13 +131,6 @@ export class PlaywrightServer {
},
id, () => semaphore.release());
},
-
- onClose: async () => {
- debugLogger.log('server', 'closing browsers');
- if (this._preLaunchedPlaywright)
- await Promise.all(this._preLaunchedPlaywright.allBrowsers().map(browser => browser.close({ reason: 'Playwright Server stopped' })));
- debugLogger.log('server', 'closed browsers');
- }
});
}
diff --git a/packages/playwright-core/src/server/dispatchers/androidDispatcher.ts b/packages/playwright-core/src/server/dispatchers/androidDispatcher.ts
index cce5f325d1..ea5d31461c 100644
--- a/packages/playwright-core/src/server/dispatchers/androidDispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/androidDispatcher.ts
@@ -27,8 +27,10 @@ import type * as channels from '@protocol/channels';
export class AndroidDispatcher extends Dispatcher<Android, channels.AndroidChannel, RootDispatcher> implements channels.AndroidChannel {
_type_Android = true;
- constructor(scope: RootDispatcher, android: Android) {
+ _denyLaunch: boolean;
+ constructor(scope: RootDispatcher, android: Android, denyLaunch: boolean) {
super(scope, android, 'Android', {});
+ this._denyLaunch = denyLaunch;
}
async devices(params: channels.AndroidDevicesParams): Promise<channels.AndroidDevicesResult> {
@@ -159,6 +161,8 @@ export class AndroidDeviceDispatcher extends Dispatcher<AndroidDevice, channels.
}
async launchBrowser(params: channels.AndroidDeviceLaunchBrowserParams): Promise<channels.AndroidDeviceLaunchBrowserResult> {
+ if (this.parentScope()._denyLaunch)
+ throw new Error(`Launching more browsers is not allowed.`);
const context = await this._object.launchBrowser(params.pkg, params);
return { context: BrowserContextDispatcher.from(this, context) };
}
@@ -168,6 +172,8 @@ export class AndroidDeviceDispatcher extends Dispatcher<AndroidDevice, channels.
}
async connectToWebView(params: channels.AndroidDeviceConnectToWebViewParams): Promise<channels.AndroidDeviceConnectToWebViewResult> {
+ if (this.parentScope()._denyLaunch)
+ throw new Error(`Launching more browsers is not allowed.`);
return { context: BrowserContextDispatcher.from(this, await this._object.connectToWebView(params.socketName)) };
}
}
diff --git a/packages/playwright-core/src/server/dispatchers/browserTypeDispatcher.ts b/packages/playwright-core/src/server/dispatchers/browserTypeDispatcher.ts
index e97b7cdc75..3b71e04072 100644
--- a/packages/playwright-core/src/server/dispatchers/browserTypeDispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/browserTypeDispatcher.ts
@@ -25,19 +25,27 @@ import type * as channels from '@protocol/channels';
export class BrowserTypeDispatcher extends Dispatcher<BrowserType, channels.BrowserTypeChannel, RootDispatcher> implements channels.BrowserTypeChannel {
_type_BrowserType = true;
- constructor(scope: RootDispatcher, browserType: BrowserType) {
+ private readonly _denyLaunch: boolean;
+ constructor(scope: RootDispatcher, browserType: BrowserType, denyLaunch: boolean) {
super(scope, browserType, 'BrowserType', {
executablePath: browserType.executablePath(),
name: browserType.name()
});
+ this._denyLaunch = denyLaunch;
}
async launch(params: channels.BrowserTypeLaunchParams, metadata: CallMetadata): Promise<channels.BrowserTypeLaunchResult> {
+ if (this._denyLaunch)
+ throw new Error(`Launching more browsers is not allowed.`);
+
const browser = await this._object.launch(metadata, params);
return { browser: new BrowserDispatcher(this, browser) };
}
async launchPersistentContext(params: channels.BrowserTypeLaunchPersistentContextParams, metadata: CallMetadata): Promise<channels.BrowserTypeLaunchPersistentContextResult> {
+ if (this._denyLaunch)
+ throw new Error(`Launching more browsers is not allowed.`);
+
const browserContext = await this._object.launchPersistentContext(metadata, params.userDataDir, params);
const browserDispatcher = new BrowserDispatcher(this, browserContext._browser);
const contextDispatcher = BrowserContextDispatcher.from(browserDispatcher, browserContext);
@@ -45,6 +53,9 @@ export class BrowserTypeDispatcher extends Dispatcher<BrowserType, channels.Brow
}
async connectOverCDP(params: channels.BrowserTypeConnectOverCDPParams, metadata: CallMetadata): Promise<channels.BrowserTypeConnectOverCDPResult> {
+ if (this._denyLaunch)
+ throw new Error(`Launching more browsers is not allowed.`);
+
const browser = await this._object.connectOverCDP(metadata, params.endpointURL, params);
const browserDispatcher = new BrowserDispatcher(this, browser);
return {
diff --git a/packages/playwright-core/src/server/dispatchers/electronDispatcher.ts b/packages/playwright-core/src/server/dispatchers/electronDispatcher.ts
index 4eab4fcfc2..7660526176 100644
--- a/packages/playwright-core/src/server/dispatchers/electronDispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/electronDispatcher.ts
@@ -28,12 +28,16 @@ import type * as channels from '@protocol/channels';
export class ElectronDispatcher extends Dispatcher<Electron, channels.ElectronChannel, RootDispatcher> implements channels.ElectronChannel {
_type_Electron = true;
+ _denyLaunch: boolean;
- constructor(scope: RootDispatcher, electron: Electron) {
+ constructor(scope: RootDispatcher, electron: Electron, denyLaunch: boolean) {
super(scope, electron, 'Electron', {});
+ this._denyLaunch = denyLaunch;
}
async launch(params: channels.ElectronLaunchParams): Promise<channels.ElectronLaunchResult> {
+ if (this._denyLaunch)
+ throw new Error(`Launching more browsers is not allowed.`);
const electronApplication = await this._object.launch(params);
return { electronApplication: new ElectronApplicationDispatcher(this, electronApplication) };
}
diff --git a/packages/playwright-core/src/server/dispatchers/playwrightDispatcher.ts b/packages/playwright-core/src/server/dispatchers/playwrightDispatcher.ts
index 63e2ba997f..74ad4b4ab0 100644
--- a/packages/playwright-core/src/server/dispatchers/playwrightDispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/playwrightDispatcher.ts
@@ -37,6 +37,7 @@ import type * as channels from '@protocol/channels';
type PlaywrightDispatcherOptions = {
socksProxy?: SocksProxy;
+ denyLaunch?: boolean;
preLaunchedBrowser?: Browser;
preLaunchedAndroidDevice?: AndroidDevice;
sharedBrowser?: boolean;
@@ -47,12 +48,13 @@ export class PlaywrightDispatcher extends Dispatcher<Playwright, channels.Playwr
private _browserDispatcher: BrowserDispatcher | undefined;
constructor(scope: RootDispatcher, playwright: Playwright, options: PlaywrightDispatcherOptions = {}) {
- const chromium = new BrowserTypeDispatcher(scope, playwright.chromium);
- const firefox = new BrowserTypeDispatcher(scope, playwright.firefox);
- const webkit = new BrowserTypeDispatcher(scope, playwright.webkit);
- const bidiChromium = new BrowserTypeDispatcher(scope, playwright.bidiChromium);
- const bidiFirefox = new BrowserTypeDispatcher(scope, playwright.bidiFirefox);
- const android = new AndroidDispatcher(scope, playwright.android);
+ const denyLaunch = options.denyLaunch ?? false;
+ const chromium = new BrowserTypeDispatcher(scope, playwright.chromium, denyLaunch);
+ const firefox = new BrowserTypeDispatcher(scope, playwright.firefox, denyLaunch);
+ const webkit = new BrowserTypeDispatcher(scope, playwright.webkit, denyLaunch);
+ const bidiChromium = new BrowserTypeDispatcher(scope, playwright.bidiChromium, denyLaunch);
+ const bidiFirefox = new BrowserTypeDispatcher(scope, playwright.bidiFirefox, denyLaunch);
+ const android = new AndroidDispatcher(scope, playwright.android, denyLaunch);
const initializer: channels.PlaywrightInitializer = {
chromium,
firefox,
@@ -60,7 +62,7 @@ export class PlaywrightDispatcher extends Dispatcher<Playwright, channels.Playwr
bidiChromium,
bidiFirefox,
android,
- electron: new ElectronDispatcher(scope, playwright.electron),
+ electron: new ElectronDispatcher(scope, playwright.electron, denyLaunch),
utils: playwright.options.isServer ? undefined : new LocalUtilsDispatcher(scope, playwright),
socksSupport: options.socksProxy ? new SocksSupportDispatcher(scope, playwright, options.socksProxy) : undefined,
};
diff --git a/packages/playwright-core/src/server/utils/wsServer.ts b/packages/playwright-core/src/server/utils/wsServer.ts
index 5251e52d3b..95fdd2f72c 100644
--- a/packages/playwright-core/src/server/utils/wsServer.ts
+++ b/packages/playwright-core/src/server/utils/wsServer.ts
@@ -46,7 +46,6 @@ export type WSServerDelegate = {
onHeaders: (headers: string[]) => void;
onUpgrade: (request: http.IncomingMessage, socket: stream.Duplex) => { error: string } | undefined;
onConnection: (request: http.IncomingMessage, url: URL, ws: WebSocket, id: string) => WSConnection;
- onClose(): Promise<void>;
};
export class WSServer {
@@ -137,7 +136,5 @@ export class WSServer {
this._wsServer = undefined;
this.server = undefined;
debugLogger.log('server', 'closed server');
-
- await this._delegate.onClose?.();
}
}
diff --git a/tests/library/browsertype-connect.spec.ts b/tests/library/browsertype-connect.spec.ts
index 1298e38b5e..80653941e6 100644
--- a/tests/library/browsertype-connect.spec.ts
+++ b/tests/library/browsertype-connect.spec.ts
@@ -1039,6 +1039,12 @@ test.describe('launchServer only', () => {
});
}
});
+
+ test('cannot launch another browser', async ({ connect, startRemoteServer }) => {
+ const remoteServer = await startRemoteServer('launchServer');
+ 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 refuse connecting when versions do not match', async ({ connect, childProcess }) => {