chore(bidi): use bidi- channels with playwright.chromium (#37702)

Author: yury-s

packages/playwright-client/types/types.d.ts

@@ -16290,7 +16290,6 @@ export type AndroidKey =
 
 export const _electron: Electron;
 export const _android: Android;
-export const _bidiChromium: BrowserType;
 
 // This is required to not export everything by default. See https://github.com/Microsoft/TypeScript/issues/19545#issuecomment-340490459
 export {};

packages/playwright-core/src/browserServerImpl.ts

@@ -32,9 +32,9 @@ import type { WebSocketEventEmitter } from './utilsBundle';
 import type { Browser } from './server/browser';
 
 export class BrowserServerLauncherImpl implements BrowserServerLauncher {
-  private _browserName: 'chromium' | 'firefox' | 'webkit' | '_bidiChromium';
+  private _browserName: 'chromium' | 'firefox' | 'webkit';
 
-  constructor(browserName: 'chromium' | 'firefox' | 'webkit' | '_bidiChromium') {
+  constructor(browserName: 'chromium' | 'firefox' | 'webkit') {
     this._browserName = browserName;
   }
 

packages/playwright-core/src/client/playwright.ts

@@ -29,7 +29,6 @@ import type { BrowserContextOptions, LaunchOptions } from 'playwright-core';
 export class Playwright extends ChannelOwner<channels.PlaywrightChannel> {
   readonly _android: Android;
   readonly _electron: Electron;
-  readonly _bidiChromium: BrowserType;
   readonly chromium: BrowserType;
   readonly firefox: BrowserType;
   readonly webkit: BrowserType;
@@ -57,8 +56,6 @@ export class Playwright extends ChannelOwner<channels.PlaywrightChannel> {
     this._android._playwright = this;
     this._electron = Electron.from(initializer.electron);
     this._electron._playwright = this;
-    this._bidiChromium = BrowserType.from(initializer._bidiChromium);
-    this._bidiChromium._playwright = this;
     this.devices = this._connection.localUtils()?.devices ?? {};
     this.selectors = new Selectors(this._connection._platform);
     this.errors = { TimeoutError };
@@ -69,7 +66,7 @@ export class Playwright extends ChannelOwner<channels.PlaywrightChannel> {
   }
 
   private _browserTypes(): BrowserType[] {
-    return [this.chromium, this.firefox, this.webkit, this._bidiChromium];
+    return [this.chromium, this.firefox, this.webkit];
   }
 
   _preLaunchedBrowser(): Browser {

packages/playwright-core/src/inProcessFactory.ts

@@ -42,7 +42,6 @@ export function createInProcessPlaywright(): PlaywrightAPI {
   playwrightAPI.firefox._serverLauncher = new BrowserServerLauncherImpl('firefox');
   playwrightAPI.webkit._serverLauncher = new BrowserServerLauncherImpl('webkit');
   playwrightAPI._android._serverLauncher = new AndroidServerLauncherImpl();
-  playwrightAPI._bidiChromium._serverLauncher = new BrowserServerLauncherImpl('_bidiChromium');
 
   // Switch to async dispatch after we got Playwright object.
   dispatcherConnection.onmessage = message => setImmediate(() => clientConnection.dispatch(message));

packages/playwright-core/src/protocol/validator.ts

@@ -377,7 +377,6 @@ scheme.PlaywrightInitializer = tObject({
   chromium: tChannel(['BrowserType']),
   firefox: tChannel(['BrowserType']),
   webkit: tChannel(['BrowserType']),
-  _bidiChromium: tChannel(['BrowserType']),
   android: tChannel(['Android']),
   electron: tChannel(['Electron']),
   utils: tOptional(tChannel(['LocalUtils'])),

packages/playwright-core/src/server/bidi/bidiChromium.ts

@@ -33,7 +33,7 @@ import type * as types from '../types';
 
 export class BidiChromium extends BrowserType {
   constructor(parent: SdkObject) {
-    super(parent, '_bidiChromium');
+    super(parent, 'chromium');
   }
 
   override async connectToTransport(transport: ConnectionTransport, options: BrowserOptions, browserLogsCollector: RecentLogsCollector): Promise<BidiBrowser> {

packages/playwright-core/src/server/chromium/chromium.ts

@@ -44,22 +44,38 @@ import type { SdkObject } from '../instrumentation';
 import type { Progress } from '../progress';
 import type { ProtocolError } from '../protocolError';
 import type { ConnectionTransport, ProtocolRequest } from '../transport';
+import type { BrowserContext } from '../browserContext';
 import type * as types from '../types';
+import type * as channels from '@protocol/channels';
 import type http from 'http';
 import type stream from 'stream';
 
 const ARTIFACTS_FOLDER = path.join(os.tmpdir(), 'playwright-artifacts-');
 
 export class Chromium extends BrowserType {
   private _devtools: CRDevTools | undefined;
+  private _bidiChromium: BrowserType;
 
-  constructor(parent: SdkObject) {
+  constructor(parent: SdkObject, bidiChromium: BrowserType) {
     super(parent, 'chromium');
+    this._bidiChromium = bidiChromium;
 
     if (debugMode() === 'inspector')
       this._devtools = this._createDevTools();
   }
 
+  override launch(progress: Progress, options: types.LaunchOptions, protocolLogger?: types.ProtocolLogger): Promise<Browser> {
+    if (options.channel?.startsWith('bidi-'))
+      return this._bidiChromium.launch(progress, options, protocolLogger);
+    return super.launch(progress, options, protocolLogger);
+  }
+
+  override async launchPersistentContext(progress: Progress, userDataDir: string, options: channels.BrowserTypeLaunchPersistentContextOptions & { cdpPort?: number, internalIgnoreHTTPSErrors?: boolean, socksProxyPort?: number }): Promise<BrowserContext> {
+    if (options.channel?.startsWith('bidi-'))
+      return this._bidiChromium.launchPersistentContext(progress, userDataDir, options);
+    return super.launchPersistentContext(progress, userDataDir, options);
+  }
+
   override async connectOverCDP(progress: Progress, endpointURL: string, options: { slowMo?: number, headers?: types.HeadersArray }) {
     return await this._connectOverCDPInternal(progress, endpointURL, options);
   }

packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts

@@ -25,7 +25,7 @@ import { Dispatcher } from './dispatcher';
 import { FrameDispatcher } from './frameDispatcher';
 import { APIRequestContextDispatcher, RequestDispatcher, ResponseDispatcher, RouteDispatcher } from './networkDispatchers';
 import { BindingCallDispatcher, PageDispatcher, WorkerDispatcher } from './pageDispatcher';
-import { CRBrowserContext } from '../chromium/crBrowser';
+import { CRBrowser, CRBrowserContext } from '../chromium/crBrowser';
 import { serializeError } from '../errors';
 import { TracingDispatcher } from './tracingDispatcher';
 import { WebSocketRouteDispatcher } from './webSocketRouteDispatcher';
@@ -136,7 +136,7 @@ export class BrowserContextDispatcher extends Dispatcher<BrowserContext, channel
     };
     context.dialogManager.addDialogHandler(this._dialogHandler);
 
-    if (context._browser.options.name === 'chromium') {
+    if (context._browser.options.name === 'chromium' && this._object._browser instanceof CRBrowser) {
       for (const serviceWorker of (context as CRBrowserContext).serviceWorkers())
         this._dispatchEvent('serviceWorker', { worker: new WorkerDispatcher(this, serviceWorker) });
       this.addObjectListener(CRBrowserContext.CREvents.ServiceWorker, serviceWorker => this._dispatchEvent('serviceWorker', { worker: new WorkerDispatcher(this, serviceWorker) }));

packages/playwright-core/src/server/dispatchers/playwrightDispatcher.ts

@@ -53,13 +53,11 @@ export class PlaywrightDispatcher extends Dispatcher<Playwright, channels.Playwr
     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 android = new AndroidDispatcher(scope, playwright.android);
     const initializer: channels.PlaywrightInitializer = {
       chromium,
       firefox,
       webkit,
-      _bidiChromium,
       android,
       electron: new ElectronDispatcher(scope, playwright.electron, denyLaunch),
       utils: playwright.options.isServer ? undefined : new LocalUtilsDispatcher(scope, playwright),

packages/playwright-core/src/server/playwright.ts

@@ -42,7 +42,6 @@ export class Playwright extends SdkObject {
   readonly electron: Electron;
   readonly firefox: BrowserType;
   readonly webkit: BrowserType;
-  readonly _bidiChromium: BrowserType;
   readonly options: PlaywrightOptions;
   readonly debugController: DebugController;
   private _allPages = new Set<Page>();
@@ -58,8 +57,7 @@ export class Playwright extends SdkObject {
       onPageOpen: page => this._allPages.add(page),
       onPageClose: page => this._allPages.delete(page),
     }, null);
-    this.chromium = new Chromium(this);
-    this._bidiChromium = new BidiChromium(this);
+    this.chromium = new Chromium(this, new BidiChromium(this));
     this.firefox = new Firefox(this, new BidiFirefox(this));
     this.webkit = new WebKit(this);
     this.electron = new Electron(this);