mirror of
https://github.com/microsoft/playwright.git
synced 2025-06-26 21:40:17 +00:00
8538f61a72
This patch implements a new mode of network tethering for Playwright server & its clients. With this patch: - playwright server could be launched with the `--browser-proxy-mode=tether` flag to engage in the new mode - a new type of client, "Network Tethering Client" can connect to the server to provide network traffic to the browsers - all clients that connect to the server with the `x-playwright-proxy: *` header will get traffic from the "Network Tethering Client" This patch also adds an environment variable `PW_OWNED_BY_TETHER_CLIENT`. With this env, playwright server will auto-close when the network tethering client disconnects. It will also auto-close if the network client does not connect to the server in the first 10 seconds of the server existence. This way we can ensure that `npx playwright docker start` blocks terminal & controls the lifetime of the started container.
84 lines
3.0 KiB
TypeScript
84 lines
3.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 * as channels from '@protocol/channels';
|
|
import { TimeoutError } from '../common/errors';
|
|
import { Android } from './android';
|
|
import { BrowserType } from './browserType';
|
|
import { ChannelOwner } from './channelOwner';
|
|
import { Electron } from './electron';
|
|
import { APIRequest } from './fetch';
|
|
import { Selectors, SelectorsOwner } from './selectors';
|
|
import type { Size } from './types';
|
|
|
|
type DeviceDescriptor = {
|
|
userAgent: string,
|
|
viewport: Size,
|
|
deviceScaleFactor: number,
|
|
isMobile: boolean,
|
|
hasTouch: boolean,
|
|
defaultBrowserType: 'chromium' | 'firefox' | 'webkit'
|
|
};
|
|
type Devices = { [name: string]: DeviceDescriptor };
|
|
|
|
export class Playwright extends ChannelOwner<channels.PlaywrightChannel> {
|
|
readonly _android: Android;
|
|
readonly _electron: Electron;
|
|
readonly chromium: BrowserType;
|
|
readonly firefox: BrowserType;
|
|
readonly webkit: BrowserType;
|
|
readonly devices: Devices;
|
|
selectors: Selectors;
|
|
readonly request: APIRequest;
|
|
readonly errors: { TimeoutError: typeof TimeoutError };
|
|
|
|
constructor(parent: ChannelOwner, type: string, guid: string, initializer: channels.PlaywrightInitializer) {
|
|
super(parent, type, guid, initializer);
|
|
this.request = new APIRequest(this);
|
|
this.chromium = BrowserType.from(initializer.chromium);
|
|
this.chromium._playwright = this;
|
|
this.firefox = BrowserType.from(initializer.firefox);
|
|
this.firefox._playwright = this;
|
|
this.webkit = BrowserType.from(initializer.webkit);
|
|
this.webkit._playwright = this;
|
|
this._android = Android.from(initializer.android);
|
|
this._electron = Electron.from(initializer.electron);
|
|
this.devices = {};
|
|
for (const { name, descriptor } of initializer.deviceDescriptors)
|
|
this.devices[name] = descriptor;
|
|
this.selectors = new Selectors();
|
|
this.errors = { TimeoutError };
|
|
|
|
const selectorsOwner = SelectorsOwner.from(initializer.selectors);
|
|
this.selectors._addChannel(selectorsOwner);
|
|
this._connection.on('close', () => {
|
|
this.selectors._removeChannel(selectorsOwner);
|
|
});
|
|
(global as any)._playwrightInstance = this;
|
|
}
|
|
|
|
_setSelectors(selectors: Selectors) {
|
|
const selectorsOwner = SelectorsOwner.from(this._initializer.selectors);
|
|
this.selectors._removeChannel(selectorsOwner);
|
|
this.selectors = selectors;
|
|
this.selectors._addChannel(selectorsOwner);
|
|
}
|
|
|
|
static from(channel: channels.PlaywrightChannel): Playwright {
|
|
return (channel as any)._object;
|
|
}
|
|
}
|