playwright/tests/config/proxy.ts
Max Schmitt 0f3bd9835f
test: update 'proxy' dependency to v2 (#28895)
This won't fix it yet, but prepare for a smaller version bump once the
upstream fix has been merged.
https://github.com/microsoft/playwright/issues/28701.
2024-01-08 19:57:46 +01:00

105 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 type { IncomingMessage } from 'http';
import type { Socket } from 'net';
import type { ProxyServer } from 'proxy';
import { createProxy } from 'proxy';
export class TestProxy {
readonly PORT: number;
readonly URL: string;
connectHosts: string[] = [];
requestUrls: string[] = [];
private readonly _server: ProxyServer;
private readonly _sockets = new Set<Socket>();
private _handlers: { event: string, handler: (...args: any[]) => void }[] = [];
static async create(port: number): Promise<TestProxy> {
const proxy = new TestProxy(port);
await new Promise<void>(f => proxy._server.listen(port, f));
return proxy;
}
private constructor(port: number) {
this.PORT = port;
this.URL = `http://localhost:${port}`;
this._server = createProxy();
this._server.on('connection', socket => this._onSocket(socket));
}
async stop(): Promise<void> {
this.reset();
for (const socket of this._sockets)
socket.destroy();
this._sockets.clear();
await new Promise(x => this._server.close(x));
}
forwardTo(port: number, options?: { allowConnectRequests: boolean }) {
this._prependHandler('request', (req: IncomingMessage) => {
this.requestUrls.push(req.url);
const url = new URL(req.url);
url.host = `localhost:${port}`;
req.url = url.toString();
});
this._prependHandler('connect', (req: IncomingMessage) => {
if (!options?.allowConnectRequests)
return;
this.connectHosts.push(req.url);
req.url = `localhost:${port}`;
});
}
setAuthHandler(handler: (req: IncomingMessage) => boolean) {
this._server.authenticate = (req: IncomingMessage) => {
try {
return handler(req);
} catch (e) {
return false;
}
};
}
reset() {
this.connectHosts = [];
this.requestUrls = [];
for (const { event, handler } of this._handlers)
this._server.removeListener(event, handler);
this._handlers = [];
this._server.authenticate = undefined;
}
private _prependHandler(event: string, handler: (...args: any[]) => void) {
this._handlers.push({ event, handler });
this._server.prependListener(event, handler);
}
private _onSocket(socket: Socket) {
this._sockets.add(socket);
// ECONNRESET and HPE_INVALID_EOF_STATE are legit errors given
// that tab closing aborts outgoing connections to the server.
socket.on('error', (error: any) => {
if (error.code !== 'ECONNRESET' && error.code !== 'HPE_INVALID_EOF_STATE')
throw error;
});
socket.once('close', () => this._sockets.delete(socket));
}
}