Skip to content

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

chore: validate launchOptions options (#36276)

Max Schmitt0bf6c3d56b20
diff --git a/packages/playwright-core/src/DEPS.list b/packages/playwright-core/src/DEPS.list
index d21eb103c4..c4f50cb22e 100644
--- a/packages/playwright-core/src/DEPS.list
+++ b/packages/playwright-core/src/DEPS.list
@@ -4,6 +4,8 @@ server/
server/utils
utils/isomorphic/
utilsBundle.ts
+protocol/validator.ts
+protocol/validatorPrimitives.ts
[androidServerImpl.ts]
remote/
diff --git a/packages/playwright-core/src/browserServerImpl.ts b/packages/playwright-core/src/browserServerImpl.ts
index 927bb6d68d..34881f133f 100644
--- a/packages/playwright-core/src/browserServerImpl.ts
+++ b/packages/playwright-core/src/browserServerImpl.ts
@@ -20,9 +20,11 @@ import { helper } from './server/helper';
import { serverSideCallMetadata } from './server/instrumentation';
import { createPlaywright } from './server/playwright';
import { createGuid } from './server/utils/crypto';
+import { isUnderTest } from './server/utils/debug';
import { rewriteErrorMessage } from './utils/isomorphic/stackTrace';
import { DEFAULT_PLAYWRIGHT_LAUNCH_TIMEOUT } from './utils/isomorphic/time';
import { ws } from './utilsBundle';
+import * as validatorPrimitives from './protocol/validatorPrimitives';
import type { BrowserServer, BrowserServerLauncher } from './client/browserType';
import type { LaunchServerOptions, Logger, Env } from './client/types';
@@ -45,19 +47,31 @@ export class BrowserServerLauncherImpl implements BrowserServerLauncher {
// 1. Pre-launch the browser
const metadata = serverSideCallMetadata();
- const launchOptions = {
+ const validatorContext = {
+ tChannelImpl: (names: '*' | string[], arg: any, path: string) => {
+ throw new validatorPrimitives.ValidationError(`${path}: channels are not expected in launchServer`);
+ },
+ binary: 'buffer',
+ isUnderTest,
+ } satisfies validatorPrimitives.ValidatorContext;
+ let launchOptions = {
...options,
ignoreDefaultArgs: Array.isArray(options.ignoreDefaultArgs) ? options.ignoreDefaultArgs : undefined,
ignoreAllDefaultArgs: !!options.ignoreDefaultArgs && !Array.isArray(options.ignoreDefaultArgs),
env: options.env ? envObjectToArray(options.env) : undefined,
timeout: options.timeout ?? DEFAULT_PLAYWRIGHT_LAUNCH_TIMEOUT,
};
+
let browser: Browser;
try {
if (options._userDataDir !== undefined) {
+ const validator = validatorPrimitives.scheme['BrowserTypeLaunchPersistentContextParams'];
+ launchOptions = validator({ ...launchOptions, userDataDir: options._userDataDir }, '', validatorContext);
const context = await playwright[this._browserName].launchPersistentContext(metadata, options._userDataDir, launchOptions);
browser = context._browser;
} else {
+ const validator = validatorPrimitives.scheme['BrowserTypeLaunchParams'];
+ launchOptions = validator(launchOptions, '', validatorContext);
browser = await playwright[this._browserName].launch(metadata, launchOptions, toProtocolLogger(options.logger));
}
} catch (e) {
diff --git a/tests/library/browsertype-launch-server.spec.ts b/tests/library/browsertype-launch-server.spec.ts
index f56d9d500e..fed973dde5 100644
--- a/tests/library/browsertype-launch-server.spec.ts
+++ b/tests/library/browsertype-launch-server.spec.ts
@@ -26,6 +26,10 @@ it.describe('launch server', () => {
await browserServer.close();
});
+ it('should validate options', async ({ browserType }) => {
+ await expect(browserType.launchServer({ channel: null })).rejects.toThrow(/channel: expected string, got object/);
+ });
+
it('should work with host', async ({ browserType }) => {
const host = '0.0.0.0';
const browserServer = await browserType.launchServer({ host });