playwright/packages/playwright-core/src/server/playwright.ts
Yury Semikhatsky daab42fa41 chore: identify largest gaps in Bidi API
This pull request introduces initial support for the WebDriver BiDi protocol in Playwright. The primary goal of this PR is not to fully implement BiDi but to experiment with the current state of the specification and its implementation. We aim to identify the biggest gaps and challenges that need to be addressed before considering BiDi as the main protocol for Playwright.
2024-09-04 11:06:26 -07:00

92 lines
3.2 KiB
TypeScript

/**
* Copyright (c) Microsoft Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { Android } from './android/android';
import { AdbBackend } from './android/backendAdb';
import type { Browser } from './browser';
import { Chromium } from './chromium/chromium';
import { Electron } from './electron/electron';
import { Firefox } from './firefox/firefox';
import { Selectors } from './selectors';
import { WebKit } from './webkit/webkit';
import type { CallMetadata } from './instrumentation';
import { createInstrumentation, SdkObject } from './instrumentation';
import { debugLogger, type Language } from '../utils';
import type { Page } from './page';
import { DebugController } from './debugController';
import type { BrowserType } from './browserType';
import { BidiFirefox } from './bidi/bidiFirefox';
type PlaywrightOptions = {
socksProxyPort?: number;
sdkLanguage: Language;
isInternalPlaywright?: boolean;
isServer?: boolean;
};
export class Playwright extends SdkObject {
readonly selectors: Selectors;
readonly chromium: BrowserType;
readonly android: Android;
readonly electron: Electron;
readonly bidiFirefox;
readonly firefox: BrowserType;
readonly webkit: BrowserType;
readonly options: PlaywrightOptions;
readonly debugController: DebugController;
private _allPages = new Set<Page>();
private _allBrowsers = new Set<Browser>();
constructor(options: PlaywrightOptions) {
super({ attribution: {}, instrumentation: createInstrumentation() } as any, undefined, 'Playwright');
this.options = options;
this.attribution.playwright = this;
this.instrumentation.addListener({
onBrowserOpen: browser => this._allBrowsers.add(browser),
onBrowserClose: browser => this._allBrowsers.delete(browser),
onPageOpen: page => this._allPages.add(page),
onPageClose: page => this._allPages.delete(page),
onCallLog: (sdkObject: SdkObject, metadata: CallMetadata, logName: string, message: string) => {
debugLogger.log(logName as any, message);
}
}, null);
this.chromium = new Chromium(this);
this.bidiFirefox = new BidiFirefox(this);
this.firefox = new Firefox(this);
this.webkit = new WebKit(this);
this.electron = new Electron(this);
this.android = new Android(this, new AdbBackend());
this.selectors = new Selectors();
this.debugController = new DebugController(this);
}
async hideHighlight() {
await Promise.all([...this._allPages].map(p => p.hideHighlight().catch(() => {})));
}
allBrowsers(): Browser[] {
return [...this._allBrowsers];
}
allPages(): Page[] {
return [...this._allPages];
}
}
export function createPlaywright(options: PlaywrightOptions) {
return new Playwright(options);
}