mirror of
https://github.com/microsoft/playwright.git
synced 2024-12-15 14:11:50 +03:00
14a1eaa474
This makes it easier to plumb all kinds of options around.
86 lines
4.0 KiB
TypeScript
86 lines
4.0 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 type { LaunchServerOptions, Logger } from './client/types';
|
|
import { ws } from './utilsBundle';
|
|
import type { WebSocketEventEmitter } from './utilsBundle';
|
|
import type { BrowserServerLauncher, BrowserServer } from './client/browserType';
|
|
import { envObjectToArray } from './client/clientHelper';
|
|
import { createGuid } from './utils';
|
|
import type { ProtocolLogger } from './server/types';
|
|
import { serverSideCallMetadata } from './server/instrumentation';
|
|
import { createPlaywright } from './server/playwright';
|
|
import { PlaywrightServer } from './remote/playwrightServer';
|
|
import { helper } from './server/helper';
|
|
import { rewriteErrorMessage } from './utils/stackTrace';
|
|
import { SocksProxy } from './common/socksProxy';
|
|
|
|
export class BrowserServerLauncherImpl implements BrowserServerLauncher {
|
|
private _browserName: 'chromium' | 'firefox' | 'webkit';
|
|
|
|
constructor(browserName: 'chromium' | 'firefox' | 'webkit') {
|
|
this._browserName = browserName;
|
|
}
|
|
|
|
async launchServer(options: LaunchServerOptions = {}): Promise<BrowserServer> {
|
|
const playwright = createPlaywright({ sdkLanguage: 'javascript', isServer: true });
|
|
// TODO: enable socks proxy once ipv6 is supported.
|
|
const socksProxy = false ? new SocksProxy() : undefined;
|
|
playwright.options.socksProxyPort = await socksProxy?.listen(0);
|
|
|
|
// 1. Pre-launch the browser
|
|
const metadata = serverSideCallMetadata();
|
|
const browser = await playwright[this._browserName].launch(metadata, {
|
|
...options,
|
|
ignoreDefaultArgs: Array.isArray(options.ignoreDefaultArgs) ? options.ignoreDefaultArgs : undefined,
|
|
ignoreAllDefaultArgs: !!options.ignoreDefaultArgs && !Array.isArray(options.ignoreDefaultArgs),
|
|
env: options.env ? envObjectToArray(options.env) : undefined,
|
|
}, toProtocolLogger(options.logger)).catch(e => {
|
|
const log = helper.formatBrowserLogs(metadata.log);
|
|
rewriteErrorMessage(e, `${e.message} Failed to launch browser.${log}`);
|
|
throw e;
|
|
});
|
|
|
|
const path = options.wsPath ? (options.wsPath.startsWith('/') ? options.wsPath : `/${options.wsPath}`) : `/${createGuid()}`;
|
|
|
|
// 2. Start the server
|
|
const server = new PlaywrightServer({ mode: 'launchServer', path, maxConnections: Infinity, preLaunchedBrowser: browser, preLaunchedSocksProxy: socksProxy });
|
|
const wsEndpoint = await server.listen(options.port);
|
|
|
|
// 3. Return the BrowserServer interface
|
|
const browserServer = new ws.EventEmitter() as (BrowserServer & WebSocketEventEmitter);
|
|
browserServer.process = () => browser.options.browserProcess.process!;
|
|
browserServer.wsEndpoint = () => wsEndpoint;
|
|
browserServer.close = () => browser.options.browserProcess.close();
|
|
browserServer.kill = () => browser.options.browserProcess.kill();
|
|
(browserServer as any)._disconnectForTest = () => server.close();
|
|
(browserServer as any)._userDataDirForTest = (browser as any)._userDataDirForTest;
|
|
browser.options.browserProcess.onclose = (exitCode, signal) => {
|
|
socksProxy?.close().catch(() => {});
|
|
server.close();
|
|
browserServer.emit('close', exitCode, signal);
|
|
};
|
|
return browserServer;
|
|
}
|
|
}
|
|
|
|
function toProtocolLogger(logger: Logger | undefined): ProtocolLogger | undefined {
|
|
return logger ? (direction: 'send' | 'receive', message: object) => {
|
|
if (logger.isEnabled('protocol', 'verbose'))
|
|
logger.log('protocol', 'verbose', (direction === 'send' ? 'SEND ► ' : '◀ RECV ') + JSON.stringify(message), [], {});
|
|
} : undefined;
|
|
}
|