Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
TypeScript automationchromechromiume2e-testingelectronend-to-end-testingfirefoxjavascriptplaywrighttesttest-automationtestingtesting-toolswebwebkit
chore: prework for web ws connection (#34718)
Pavel Feldman72cd6f06aaee
diff --git a/packages/playwright-core/src/client/localUtils.ts b/packages/playwright-core/src/client/localUtils.tsindex ba1e961c7f..8ab7421980 100644--- a/packages/playwright-core/src/client/localUtils.ts+++ b/packages/playwright-core/src/client/localUtils.ts@@ -18,8 +18,9 @@ import { ChannelOwner } from './channelOwner';import { Connection } from './connection';import * as localUtils from '../utils/localUtils';-import type { Size } from './types';+import type { HeadersArray, Size } from './types';import type { HarBackend } from '../utils/harBackend';+import type { Platform } from '../utils/platform';import type * as channels from '@protocol/channels';type DeviceDescriptor = {@@ -78,27 +79,100 @@ export class LocalUtils extends ChannelOwner<channels.LocalUtilsChannel> {}async connect(params: channels.LocalUtilsConnectParams): Promise<Connection> {- const { pipe, headers: connectHeaders } = await this._channel.connect(params);- const closePipe = () => this._wrapApiCall(() => pipe.close().catch(() => {}), /* isInternal */ true);+ const transport = this._platform.ws ? new WebSocketTransport(this._platform) : new JsonPipeTransport(this);+ const connectHeaders = await transport.connect(params);const connection = new Connection(this, this._platform, this._instrumentation, connectHeaders);connection.markAsRemote();- connection.on('close', closePipe);+ connection.on('close', () => transport.close());let closeError: string | undefined;- const onPipeClosed = (reason?: string) => {+ const onTransportClosed = (reason?: string) => {connection.close(reason || closeError);};- pipe.on('closed', params => onPipeClosed(params.reason));- connection.onmessage = message => this._wrapApiCall(() => pipe.send({ message }).catch(() => onPipeClosed()), /* isInternal */ true);-- pipe.on('message', ({ message }) => {+ transport.onClose(reason => onTransportClosed(reason));+ connection.onmessage = message => transport.send(message).catch(() => onTransportClosed());+ transport.onMessage(message => {try {connection!.dispatch(message);} catch (e) {closeError = String(e);- closePipe();+ transport.close();}});return connection;}}+interface Transport {+ connect(params: channels.LocalUtilsConnectParams): Promise<HeadersArray>;+ send(message: any): Promise<void>;+ onMessage(callback: (message: object) => void): void;+ onClose(callback: (reason?: string) => void): void;+ close(): Promise<void>;+}++class JsonPipeTransport implements Transport {+ private _pipe: channels.JsonPipeChannel | undefined;+ private _owner: ChannelOwner<channels.LocalUtilsChannel>;++ constructor(owner: ChannelOwner<channels.LocalUtilsChannel>) {+ this._owner = owner;+ }++ async connect(params: channels.LocalUtilsConnectParams) {+ const { pipe, headers: connectHeaders } = await this._owner._wrapApiCall(async () => {+ return await this._owner._channel.connect(params);+ }, /* isInternal */ true);+ this._pipe = pipe;+ return connectHeaders;+ }++ async send(message: object) {+ this._owner._wrapApiCall(async () => {+ await this._pipe!.send({ message });+ }, /* isInternal */ true);+ }++ onMessage(callback: (message: object) => void) {+ this._pipe!.on('message', ({ message }) => callback(message));+ }++ onClose(callback: (reason?: string) => void) {+ this._pipe!.on('closed', ({ reason }) => callback(reason));+ }++ async close() {+ await this._owner._wrapApiCall(async () => {+ await this._pipe!.close().catch(() => {});+ }, /* isInternal */ true);+ }+}++class WebSocketTransport implements Transport {+ private _platform: Platform;+ private _ws: WebSocket | undefined;++ constructor(platform: Platform) {+ this._platform = platform;+ }++ async connect(params: channels.LocalUtilsConnectParams) {+ this._ws = this._platform.ws!(params.wsEndpoint);+ return [];+ }++ async send(message: object) {+ this._ws!.send(JSON.stringify(message));+ }++ onMessage(callback: (message: object) => void) {+ this._ws!.addEventListener('message', event => callback(JSON.parse(event.data)));+ }++ onClose(callback: (reason?: string) => void) {+ this._ws!.addEventListener('close', () => callback());+ }++ async close() {+ this._ws!.close();+ }+}diff --git a/packages/playwright-core/src/utils/platform.ts b/packages/playwright-core/src/utils/platform.tsindex 1678875491..e682ad46b0 100644--- a/packages/playwright-core/src/utils/platform.ts+++ b/packages/playwright-core/src/utils/platform.ts@@ -22,6 +22,7 @@ export type Platform = {fs: () => typeof fs;path: () => typeof path;inspectCustom: symbol | undefined;+ ws?: (url: string) => WebSocket;};export const emptyPlatform: Platform = {@@ -41,3 +42,8 @@ export const nodePlatform: Platform = {path: () => path,inspectCustom: util.inspect.custom,};++export const webPlatform: Platform = {+ ...emptyPlatform,+ ws: (url: string) => new WebSocket(url),+};