/** * 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 type { Browser } from '../server/browser'; import type { Playwright } from '../server/playwright'; import { createPlaywright } from '../server/playwright'; import { PlaywrightConnection } from './playwrightConnection'; import type { ClientType } from './playwrightConnection'; import type { LaunchOptions } from '../server/types'; import { Semaphore } from '../utils/semaphore'; import type { AndroidDevice } from '../server/android/android'; import type { SocksProxy } from '../common/socksProxy'; import { debugLogger } from '../utils/debugLogger'; import { userAgentVersionMatchesErrorMessage } from '../utils'; import { WSServer } from '../utils/wsServer'; type ServerOptions = { path: string; maxConnections: number; mode: 'default' | 'launchServer' | 'extension'; preLaunchedBrowser?: Browser; preLaunchedAndroidDevice?: AndroidDevice; preLaunchedSocksProxy?: SocksProxy; }; export class PlaywrightServer { private _preLaunchedPlaywright: Playwright | undefined; private _options: ServerOptions; private _wsServer: WSServer; constructor(options: ServerOptions) { this._options = options; if (options.preLaunchedBrowser) this._preLaunchedPlaywright = options.preLaunchedBrowser.attribution.playwright; if (options.preLaunchedAndroidDevice) this._preLaunchedPlaywright = options.preLaunchedAndroidDevice._android.attribution.playwright; const browserSemaphore = new Semaphore(this._options.maxConnections); const controllerSemaphore = new Semaphore(1); const reuseBrowserSemaphore = new Semaphore(1); this._wsServer = new WSServer({ onUpgrade: (request, socket) => { const uaError = userAgentVersionMatchesErrorMessage(request.headers['user-agent'] || ''); if (uaError) return { error: `HTTP/${request.httpVersion} 428 Precondition Required\r\n\r\n${uaError}` }; }, onHeaders: headers => { if (process.env.PWTEST_SERVER_WS_HEADERS) headers.push(process.env.PWTEST_SERVER_WS_HEADERS!); }, onConnection: (request, url, ws, id) => { const browserHeader = request.headers['x-playwright-browser']; const browserName = url.searchParams.get('browser') || (Array.isArray(browserHeader) ? browserHeader[0] : browserHeader) || null; const proxyHeader = request.headers['x-playwright-proxy']; const proxyValue = url.searchParams.get('proxy') || (Array.isArray(proxyHeader) ? proxyHeader[0] : proxyHeader); const launchOptionsHeader = request.headers['x-playwright-launch-options'] || ''; const launchOptionsHeaderValue = Array.isArray(launchOptionsHeader) ? launchOptionsHeader[0] : launchOptionsHeader; const launchOptionsParam = url.searchParams.get('launch-options'); let launchOptions: LaunchOptions = {}; try { launchOptions = JSON.parse(launchOptionsParam || launchOptionsHeaderValue); } catch (e) { } // Instantiate playwright for the extension modes. const isExtension = this._options.mode === 'extension'; if (isExtension) { if (!this._preLaunchedPlaywright) this._preLaunchedPlaywright = createPlaywright({ sdkLanguage: 'javascript', isServer: true }); } let clientType: ClientType = 'launch-browser'; let semaphore: Semaphore = browserSemaphore; if (isExtension && url.searchParams.has('debug-controller')) { clientType = 'controller'; semaphore = controllerSemaphore; } else if (isExtension) { clientType = 'reuse-browser'; semaphore = reuseBrowserSemaphore; } else if (this._options.mode === 'launchServer') { clientType = 'pre-launched-browser-or-android'; semaphore = browserSemaphore; } return new PlaywrightConnection( semaphore.acquire(), clientType, ws, { socksProxyPattern: proxyValue, browserName, launchOptions }, { playwright: this._preLaunchedPlaywright, browser: this._options.preLaunchedBrowser, androidDevice: this._options.preLaunchedAndroidDevice, socksProxy: this._options.preLaunchedSocksProxy, }, 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'); } }); } async listen(port: number = 0, hostname?: string): Promise { return this._wsServer.listen(port, hostname, this._options.path); } async close() { await this._wsServer.close(); } }