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.
87 lines
3.9 KiB
TypeScript
87 lines
3.9 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 * as socks from '../common/socksProxy';
|
|
import EventEmitter from 'events';
|
|
import type * as channels from '@protocol/channels';
|
|
import type { WebSocketTransport } from './transport';
|
|
import { findValidator, ValidationError } from '../protocol/validator';
|
|
import type { ValidatorContext } from '../protocol/validator';
|
|
|
|
export class SocksInterceptor {
|
|
private _handler: socks.SocksProxyHandler;
|
|
private _channel: channels.SocksSupportChannel & EventEmitter;
|
|
private _socksSupportObjectGuid?: string;
|
|
private _ids = new Set<number>();
|
|
|
|
constructor(transport: WebSocketTransport, redirectPortForTest: number | undefined) {
|
|
this._handler = new socks.SocksProxyHandler(redirectPortForTest);
|
|
|
|
let lastId = -1;
|
|
this._channel = new Proxy(new EventEmitter(), {
|
|
get: (obj: any, prop) => {
|
|
if ((prop in obj) || obj[prop] !== undefined || typeof prop !== 'string')
|
|
return obj[prop];
|
|
return (params: any) => {
|
|
try {
|
|
const id = --lastId;
|
|
this._ids.add(id);
|
|
const validator = findValidator('SocksSupport', prop, 'Params');
|
|
params = validator(params, '', { tChannelImpl: tChannelForSocks, binary: 'toBase64' });
|
|
transport.send({ id, guid: this._socksSupportObjectGuid, method: prop, params, metadata: { stack: [], apiName: '', internal: true } } as any);
|
|
} catch (e) {
|
|
}
|
|
};
|
|
},
|
|
}) as channels.SocksSupportChannel & EventEmitter;
|
|
this._handler.on(socks.SocksProxyHandler.Events.SocksConnected, (payload: socks.SocksSocketConnectedPayload) => this._channel.socksConnected(payload));
|
|
this._handler.on(socks.SocksProxyHandler.Events.SocksData, (payload: socks.SocksSocketDataPayload) => this._channel.socksData(payload));
|
|
this._handler.on(socks.SocksProxyHandler.Events.SocksError, (payload: socks.SocksSocketErrorPayload) => this._channel.socksError(payload));
|
|
this._handler.on(socks.SocksProxyHandler.Events.SocksFailed, (payload: socks.SocksSocketFailedPayload) => this._channel.socksFailed(payload));
|
|
this._handler.on(socks.SocksProxyHandler.Events.SocksEnd, (payload: socks.SocksSocketEndPayload) => this._channel.socksEnd(payload));
|
|
this._channel.on('socksRequested', payload => this._handler.socketRequested(payload));
|
|
this._channel.on('socksClosed', payload => this._handler.socketClosed(payload));
|
|
this._channel.on('socksData', payload => this._handler.sendSocketData(payload));
|
|
}
|
|
|
|
cleanup() {
|
|
this._handler.cleanup();
|
|
}
|
|
|
|
interceptMessage(message: any): boolean {
|
|
if (this._ids.has(message.id)) {
|
|
this._ids.delete(message.id);
|
|
return true;
|
|
}
|
|
if (message.method === '__create__' && message.params.type === 'SocksSupport') {
|
|
this._socksSupportObjectGuid = message.params.guid;
|
|
return false;
|
|
}
|
|
if (this._socksSupportObjectGuid && message.guid === this._socksSupportObjectGuid) {
|
|
const validator = findValidator('SocksSupport', message.method, 'Event');
|
|
const params = validator(message.params, '', { tChannelImpl: tChannelForSocks, binary: 'fromBase64' });
|
|
this._channel.emit(message.method, params);
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
}
|
|
|
|
function tChannelForSocks(names: '*' | string[], arg: any, path: string, context: ValidatorContext) {
|
|
throw new ValidationError(`${path}: channels are not expected in SocksSupport`);
|
|
}
|
|
|