@rushstack/playwright-browser-tunnel 0.2.4 → 0.3.0

package/lib-esm/tunneledBrowserConnection/TunneledBrowser.js

@@ -0,0 +1,36 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import playwright from 'playwright-core';
+import { ConsoleTerminalProvider, Terminal } from '@rushstack/terminal';
+import { DEFAULT_LISTEN_PORT } from './constants';
+import { tunneledBrowserConnection } from './TunneledBrowserConnection';
+/**
+ * Creates a Playwright Browser instance connected via a tunneled WebSocket connection.
+ * @beta
+ */
+export async function createTunneledBrowserAsync(browserName, launchOptions, logger, port = DEFAULT_LISTEN_PORT) {
+    // Establish the tunnel first (remoteEndpoint here refers to local proxy endpoint for connect())
+    if (!logger) {
+        const terminalProvider = new ConsoleTerminalProvider();
+        logger = new Terminal(terminalProvider);
+    }
+    const connection = await tunneledBrowserConnection(logger, port);
+    const { remoteEndpoint } = connection;
+    // Append query params for browser and launchOptions
+    const urlObj = new URL(remoteEndpoint);
+    urlObj.searchParams.set('browser', browserName);
+    urlObj.searchParams.set('launchOptions', JSON.stringify(launchOptions || {}));
+    const connectEndpoint = urlObj.toString();
+    const browser = await playwright[browserName].connect(connectEndpoint);
+    logger.writeLine(`Connected to remote browser at ${connectEndpoint}`);
+    return {
+        browser,
+        async [Symbol.asyncDispose]() {
+            logger.writeLine('Disposing browser');
+            await browser.close();
+            // Dispose the tunnel connection after browser is closed
+            connection[Symbol.dispose]();
+        }
+    };
+}
+//# sourceMappingURL=TunneledBrowser.js.map

package/lib-esm/tunneledBrowserConnection/TunneledBrowser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TunneledBrowser.js","sourceRoot":"","sources":["../../src/tunneledBrowserConnection/TunneledBrowser.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAG3D,OAAO,UAAU,MAAM,iBAAiB,CAAC;AAGzC,OAAO,EAAE,uBAAuB,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAGxE,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAGlD,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAC9C,WAAwB,EACxB,aAA4B,EAC5B,MAAkB,EAClB,OAAe,mBAAmB;IAElC,gGAAgG;IAEhG,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,gBAAgB,GAA4B,IAAI,uBAAuB,EAAE,CAAC;QAChF,MAAM,GAAG,IAAI,QAAQ,CAAC,gBAAgB,CAAC,CAAC;IAC1C,CAAC;IAED,MAAM,UAAU,GAAyC,MAAM,yBAAyB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACvG,MAAM,EAAE,cAAc,EAAE,GAAG,UAAU,CAAC;IACtC,oDAAoD;IACpD,MAAM,MAAM,GAAQ,IAAI,GAAG,CAAC,cAAc,CAAC,CAAC;IAC5C,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IAChD,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,aAAa,IAAI,EAAE,CAAC,CAAC,CAAC;IAC9E,MAAM,eAAe,GAAW,MAAM,CAAC,QAAQ,EAAE,CAAC;IAClD,MAAM,OAAO,GAAY,MAAM,UAAU,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;IAChF,MAAM,CAAC,SAAS,CAAC,kCAAkC,eAAe,EAAE,CAAC,CAAC;IAEtE,OAAO;QACL,OAAO;QACP,KAAK,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC;YACzB,MAAM,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC;YACtC,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC;YACtB,wDAAwD;YACxD,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;QAC/B,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport type { Browser, LaunchOptions } from 'playwright-core';\nimport playwright from 'playwright-core';\n\nimport type { ITerminal } from '@rushstack/terminal';\nimport { ConsoleTerminalProvider, Terminal } from '@rushstack/terminal';\n\nimport type { BrowserName } from '../PlaywrightBrowserTunnel';\nimport { DEFAULT_LISTEN_PORT } from './constants';\nimport type { IDisposableTunneledBrowser } from './ITunneledBrowser';\nimport type { IDisposableTunneledBrowserConnection } from './ITunneledBrowserConnection';\nimport { tunneledBrowserConnection } from './TunneledBrowserConnection';\n\n/**\n * Creates a Playwright Browser instance connected via a tunneled WebSocket connection.\n * @beta\n */\nexport async function createTunneledBrowserAsync(\n  browserName: BrowserName,\n  launchOptions: LaunchOptions,\n  logger?: ITerminal,\n  port: number = DEFAULT_LISTEN_PORT\n): Promise<IDisposableTunneledBrowser> {\n  // Establish the tunnel first (remoteEndpoint here refers to local proxy endpoint for connect())\n\n  if (!logger) {\n    const terminalProvider: ConsoleTerminalProvider = new ConsoleTerminalProvider();\n    logger = new Terminal(terminalProvider);\n  }\n\n  const connection: IDisposableTunneledBrowserConnection = await tunneledBrowserConnection(logger, port);\n  const { remoteEndpoint } = connection;\n  // Append query params for browser and launchOptions\n  const urlObj: URL = new URL(remoteEndpoint);\n  urlObj.searchParams.set('browser', browserName);\n  urlObj.searchParams.set('launchOptions', JSON.stringify(launchOptions || {}));\n  const connectEndpoint: string = urlObj.toString();\n  const browser: Browser = await playwright[browserName].connect(connectEndpoint);\n  logger.writeLine(`Connected to remote browser at ${connectEndpoint}`);\n\n  return {\n    browser,\n    async [Symbol.asyncDispose]() {\n      logger.writeLine('Disposing browser');\n      await browser.close();\n      // Dispose the tunnel connection after browser is closed\n      connection[Symbol.dispose]();\n    }\n  };\n}\n"]}

package/lib-esm/tunneledBrowserConnection/TunneledBrowserConnection.js

@@ -0,0 +1,195 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import playwrightPackageJson from 'playwright-core/package.json';
+import { WebSocket, WebSocketServer } from 'ws';
+import { HttpServer } from '../HttpServer';
+import { getNormalizedErrorString, getWebSocketCloseReason, getWebSocketReadyStateString, WebSocketCloseCode } from '../utilities';
+import { DEFAULT_LISTEN_PORT, SUPPORTED_BROWSER_NAMES } from './constants';
+const { version: playwrightVersion } = playwrightPackageJson;
+/**
+ * Creates a tunneled WebSocket endpoint that a local Playwright client can connect to.
+ * @beta
+ */
+export async function tunneledBrowserConnection(logger, port = DEFAULT_LISTEN_PORT) {
+    // Server that remote peer (actual browser host) connects to
+    const remoteWsServer = new WebSocketServer({ port });
+    // Local HTTP + WebSocket server where the playwright client will connect providing params
+    const httpServer = new HttpServer(logger);
+    await httpServer.listenAsync();
+    logger.writeLine(`Remote WebSocket server listening on ws://localhost:${port}`);
+    const localProxyWs = httpServer.wsServer;
+    const localProxyWsEndpoint = httpServer.endpoint;
+    let browserName;
+    let launchOptions;
+    let remoteSocket;
+    let handshakeAck = false;
+    let handshakeSent = false;
+    function maybeSendHandshake() {
+        if (!handshakeSent && remoteSocket && browserName && launchOptions) {
+            const handshake = {
+                action: 'handshake',
+                browserName,
+                launchOptions,
+                playwrightVersion
+            };
+            // Log handshake without 'headless' to avoid confusion (tunnel enforces headless: false)
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            const { headless, ...logOptions } = launchOptions;
+            const logHandshake = {
+                ...handshake,
+                launchOptions: logOptions
+            };
+            logger.writeLine(`Sending handshake to remote: ${JSON.stringify(logHandshake)}`);
+            handshakeSent = true;
+            remoteSocket.send(JSON.stringify(handshake));
+        }
+    }
+    return await new Promise((resolve) => {
+        remoteWsServer.on('error', (error) => {
+            logger.writeErrorLine(`Remote WebSocket server error: ${error}`);
+        });
+        remoteWsServer.on('close', () => {
+            logger.writeLine('Remote WebSocket server closed');
+        });
+        const bufferedLocalMessages = [];
+        remoteWsServer.on('connection', (ws) => {
+            logger.writeLine('Remote websocket connected');
+            remoteSocket = ws;
+            handshakeAck = false;
+            maybeSendHandshake();
+            ws.on('message', (message) => {
+                if (!handshakeAck) {
+                    try {
+                        const receivedHandshake = JSON.parse(message.toString());
+                        if (receivedHandshake.action === 'handshakeAck') {
+                            handshakeAck = true;
+                            logger.writeLine('Received handshakeAck from remote');
+                        }
+                        else {
+                            logger.writeErrorLine('Invalid handshake ack message');
+                            ws.close(WebSocketCloseCode.PROTOCOL_ERROR, 'Invalid handshake ack');
+                            return;
+                        }
+                    }
+                    catch (e) {
+                        logger.writeErrorLine(`Failed parsing handshake ack: ${e}`);
+                        ws.close(WebSocketCloseCode.PROTOCOL_ERROR, 'Failed parsing handshake');
+                        return;
+                    }
+                    // Resolve only once local proxy available and handshake acknowledged
+                    if (handshakeAck) {
+                        // Flush any buffered local messages now that tunnel is active
+                        const activeRemote = remoteSocket;
+                        if (activeRemote && activeRemote.readyState === WebSocket.OPEN) {
+                            while (bufferedLocalMessages.length > 0) {
+                                const m = bufferedLocalMessages.shift();
+                                if (m !== undefined) {
+                                    logger.writeLine(`Flushing buffered local message to remote: ${m}`);
+                                    activeRemote.send(m);
+                                }
+                            }
+                        }
+                    }
+                }
+                else {
+                    // Forward from remote to all local clients
+                    localProxyWs.clients.forEach((client) => {
+                        if (client.readyState === WebSocket.OPEN) {
+                            client.send(message);
+                        }
+                    });
+                }
+            });
+            ws.on('close', (code, reason) => {
+                const reasonStr = reason.toString() || 'no reason provided';
+                const codeDescription = getWebSocketCloseReason(code);
+                logger.writeDebugLine(`Remote websocket closed - code: ${code} (${codeDescription}), reason: ${reasonStr}`);
+                logger.writeDebugLine(`  Connection state at close: handshakeSent=${handshakeSent}, handshakeAck=${handshakeAck}`);
+                logger.writeDebugLine(`  Buffered messages pending: ${bufferedLocalMessages.length}`);
+            });
+            ws.on('error', (err) => {
+                logger.writeErrorLine(`Remote websocket error: ${getNormalizedErrorString(err)}`);
+                logger.writeErrorLine(`  Socket readyState: ${getWebSocketReadyStateString(ws.readyState)}`);
+            });
+        });
+        localProxyWs.on('connection', (localWs, request) => {
+            try {
+                const urlString = request === null || request === void 0 ? void 0 : request.url;
+                if (urlString) {
+                    const parsed = new URL(urlString, 'http://localhost');
+                    logger.writeLine(`Local client connected with query params: ${parsed.searchParams.toString()}`);
+                    const bName = parsed.searchParams.get('browser');
+                    if (bName && SUPPORTED_BROWSER_NAMES.has(bName)) {
+                        browserName = bName;
+                    }
+                    const launchOptionsParam = parsed.searchParams.get('launchOptions');
+                    if (launchOptionsParam) {
+                        try {
+                            launchOptions = JSON.parse(launchOptionsParam);
+                        }
+                        catch (e) {
+                            logger.writeErrorLine('Invalid launchOptions JSON provided');
+                        }
+                    }
+                }
+            }
+            catch (e) {
+                logger.writeErrorLine(`Error parsing local connection query params: ${e}`);
+            }
+            if (!browserName) {
+                const supportedBrowsersString = Array.from(SUPPORTED_BROWSER_NAMES).join('|');
+                logger.writeErrorLine(`browser query param required (${supportedBrowsersString})`);
+                localWs.close(WebSocketCloseCode.PROTOCOL_ERROR, 'Missing browser param');
+                return;
+            }
+            if (!launchOptions) {
+                launchOptions = {}; // default empty if not provided
+            }
+            maybeSendHandshake();
+            localWs.on('message', (message) => {
+                if (handshakeAck && (remoteSocket === null || remoteSocket === void 0 ? void 0 : remoteSocket.readyState) === WebSocket.OPEN) {
+                    remoteSocket.send(message);
+                }
+                else {
+                    // Buffer until handshakeAck to avoid losing early protocol messages from Playwright
+                    bufferedLocalMessages.push(message);
+                }
+            });
+            localWs.on('close', (code, reason) => {
+                const reasonStr = reason.toString() || 'no reason provided';
+                const codeDescription = getWebSocketCloseReason(code);
+                logger.writeDebugLine(`Local client websocket closed - code: ${code} (${codeDescription}), reason: ${reasonStr}`);
+                logger.writeDebugLine(`  Remote socket state: ${remoteSocket ? getWebSocketReadyStateString(remoteSocket.readyState) : 'undefined'}`);
+                logger.writeDebugLine(`  handshakeAck: ${handshakeAck}`);
+            });
+            localWs.on('error', (err) => {
+                logger.writeErrorLine(`Local client websocket error: ${getNormalizedErrorString(err)}`);
+            });
+        });
+        // Resolve immediately so caller can initiate local connection with query params (handshake completes later)
+        resolve({
+            remoteEndpoint: localProxyWsEndpoint,
+            [Symbol.dispose]() {
+                try {
+                    remoteWsServer.close();
+                }
+                catch (_a) {
+                    // ignore errors during remote WebSocket server shutdown
+                }
+                try {
+                    httpServer[Symbol.dispose]();
+                }
+                catch (_b) {
+                    // ignore errors during HTTP/WebSocket server shutdown
+                }
+            },
+            // eslint-disable-next-line promise/param-names
+            closePromise: new Promise((resolve2) => {
+                remoteWsServer.once('close', () => {
+                    resolve2();
+                });
+            })
+        });
+    });
+}
+//# sourceMappingURL=TunneledBrowserConnection.js.map

package/lib-esm/tunneledBrowserConnection/TunneledBrowserConnection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TunneledBrowserConnection.js","sourceRoot":"","sources":["../../src/tunneledBrowserConnection/TunneledBrowserConnection.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAG3D,OAAO,qBAAqB,MAAM,8BAA8B,CAAC;AAEjE,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,IAAI,CAAC;AAIhD,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C,OAAO,EACL,wBAAwB,EACxB,uBAAuB,EACvB,4BAA4B,EAC5B,kBAAkB,EACnB,MAAM,cAAc,CAAC;AAMtB,OAAO,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AAE3E,MAAM,EAAE,OAAO,EAAE,iBAAiB,EAAE,GAAG,qBAAqB,CAAC;AAE7D;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAC7C,MAAiB,EACjB,OAAe,mBAAmB;IAElC,4DAA4D;IAC5D,MAAM,cAAc,GAAoB,IAAI,eAAe,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;IACtE,0FAA0F;IAC1F,MAAM,UAAU,GAAe,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;IACtD,MAAM,UAAU,CAAC,WAAW,EAAE,CAAC;IAC/B,MAAM,CAAC,SAAS,CAAC,uDAAuD,IAAI,EAAE,CAAC,CAAC;IAEhF,MAAM,YAAY,GAAoB,UAAU,CAAC,QAAQ,CAAC;IAC1D,MAAM,oBAAoB,GAAW,UAAU,CAAC,QAAQ,CAAC;IAEzD,IAAI,WAAoC,CAAC;IACzC,IAAI,aAAwC,CAAC;IAC7C,IAAI,YAAmC,CAAC;IACxC,IAAI,YAAY,GAAY,KAAK,CAAC;IAClC,IAAI,aAAa,GAAY,KAAK,CAAC;IAEnC,SAAS,kBAAkB;QACzB,IAAI,CAAC,aAAa,IAAI,YAAY,IAAI,WAAW,IAAI,aAAa,EAAE,CAAC;YACnE,MAAM,SAAS,GAAe;gBAC5B,MAAM,EAAE,WAAW;gBACnB,WAAW;gBACX,aAAa;gBACb,iBAAiB;aAClB,CAAC;YACF,wFAAwF;YACxF,6DAA6D;YAC7D,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,EAAE,GAAG,aAAa,CAAC;YAClD,MAAM,YAAY,GAEd;gBACF,GAAG,SAAS;gBACZ,aAAa,EAAE,UAAU;aAC1B,CAAC;YACF,MAAM,CAAC,SAAS,CAAC,gCAAgC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;YACjF,aAAa,GAAG,IAAI,CAAC;YACrB,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IAED,OAAO,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QACnC,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YACnC,MAAM,CAAC,cAAc,CAAC,kCAAkC,KAAK,EAAE,CAAC,CAAC;QACnE,CAAC,CAAC,CAAC;QAEH,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YAC9B,MAAM,CAAC,SAAS,CAAC,gCAAgC,CAAC,CAAC;QACrD,CAAC,CAAC,CAAC;QAEH,MAAM,qBAAqB,GAAmB,EAAE,CAAC;QAEjD,cAAc,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,EAAE,EAAE,EAAE;YACrC,MAAM,CAAC,SAAS,CAAC,4BAA4B,CAAC,CAAC;YAC/C,YAAY,GAAG,EAAE,CAAC;YAClB,YAAY,GAAG,KAAK,CAAC;YACrB,kBAAkB,EAAE,CAAC;YAErB,EAAE,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,EAAE;gBAC3B,IAAI,CAAC,YAAY,EAAE,CAAC;oBAClB,IAAI,CAAC;wBACH,MAAM,iBAAiB,GAAkB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;wBACxE,IAAI,iBAAiB,CAAC,MAAM,KAAK,cAAc,EAAE,CAAC;4BAChD,YAAY,GAAG,IAAI,CAAC;4BACpB,MAAM,CAAC,SAAS,CAAC,mCAAmC,CAAC,CAAC;wBACxD,CAAC;6BAAM,CAAC;4BACN,MAAM,CAAC,cAAc,CAAC,+BAA+B,CAAC,CAAC;4BACvD,EAAE,CAAC,KAAK,CAAC,kBAAkB,CAAC,cAAc,EAAE,uBAAuB,CAAC,CAAC;4BACrE,OAAO;wBACT,CAAC;oBACH,CAAC;oBAAC,OAAO,CAAC,EAAE,CAAC;wBACX,MAAM,CAAC,cAAc,CAAC,iCAAiC,CAAC,EAAE,CAAC,CAAC;wBAC5D,EAAE,CAAC,KAAK,CAAC,kBAAkB,CAAC,cAAc,EAAE,0BAA0B,CAAC,CAAC;wBACxE,OAAO;oBACT,CAAC;oBACD,qEAAqE;oBACrE,IAAI,YAAY,EAAE,CAAC;wBACjB,8DAA8D;wBAC9D,MAAM,YAAY,GAA0B,YAAY,CAAC;wBACzD,IAAI,YAAY,IAAI,YAAY,CAAC,UAAU,KAAK,SAAS,CAAC,IAAI,EAAE,CAAC;4BAC/D,OAAO,qBAAqB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gCACxC,MAAM,CAAC,GAAyD,qBAAqB,CAAC,KAAK,EAAE,CAAC;gCAC9F,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;oCACpB,MAAM,CAAC,SAAS,CAAC,8CAA8C,CAAC,EAAE,CAAC,CAAC;oCACpE,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;gCACvB,CAAC;4BACH,CAAC;wBACH,CAAC;oBACH,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,2CAA2C;oBAC3C,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;wBACtC,IAAI,MAAM,CAAC,UAAU,KAAK,SAAS,CAAC,IAAI,EAAE,CAAC;4BACzC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;wBACvB,CAAC;oBACH,CAAC,CAAC,CAAC;gBACL,CAAC;YACH,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,IAAY,EAAE,MAAc,EAAE,EAAE;gBAC9C,MAAM,SAAS,GAAW,MAAM,CAAC,QAAQ,EAAE,IAAI,oBAAoB,CAAC;gBACpE,MAAM,eAAe,GAAW,uBAAuB,CAAC,IAAI,CAAC,CAAC;gBAC9D,MAAM,CAAC,cAAc,CACnB,mCAAmC,IAAI,KAAK,eAAe,cAAc,SAAS,EAAE,CACrF,CAAC;gBACF,MAAM,CAAC,cAAc,CACnB,8CAA8C,aAAa,kBAAkB,YAAY,EAAE,CAC5F,CAAC;gBACF,MAAM,CAAC,cAAc,CAAC,gCAAgC,qBAAqB,CAAC,MAAM,EAAE,CAAC,CAAC;YACxF,CAAC,CAAC,CAAC;YACH,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAU,EAAE,EAAE;gBAC5B,MAAM,CAAC,cAAc,CAAC,2BAA2B,wBAAwB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gBAClF,MAAM,CAAC,cAAc,CAAC,wBAAwB,4BAA4B,CAAC,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;YAC/F,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,YAAY,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE;YACjD,IAAI,CAAC;gBACH,MAAM,SAAS,GAAuB,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,GAAG,CAAC;gBACnD,IAAI,SAAS,EAAE,CAAC;oBACd,MAAM,MAAM,GAAQ,IAAI,GAAG,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAAC;oBAC3D,MAAM,CAAC,SAAS,CAAC,6CAA6C,MAAM,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;oBAChG,MAAM,KAAK,GAAkB,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;oBAChE,IAAI,KAAK,IAAI,uBAAuB,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;wBAChD,WAAW,GAAG,KAAoB,CAAC;oBACrC,CAAC;oBACD,MAAM,kBAAkB,GAAkB,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;oBACnF,IAAI,kBAAkB,EAAE,CAAC;wBACvB,IAAI,CAAC;4BACH,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;wBACjD,CAAC;wBAAC,OAAO,CAAC,EAAE,CAAC;4BACX,MAAM,CAAC,cAAc,CAAC,qCAAqC,CAAC,CAAC;wBAC/D,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,MAAM,CAAC,cAAc,CAAC,gDAAgD,CAAC,EAAE,CAAC,CAAC;YAC7E,CAAC;YAED,IAAI,CAAC,WAAW,EAAE,CAAC;gBACjB,MAAM,uBAAuB,GAAW,KAAK,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACtF,MAAM,CAAC,cAAc,CAAC,iCAAiC,uBAAuB,GAAG,CAAC,CAAC;gBACnF,OAAO,CAAC,KAAK,CAAC,kBAAkB,CAAC,cAAc,EAAE,uBAAuB,CAAC,CAAC;gBAC1E,OAAO;YACT,CAAC;YACD,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,aAAa,GAAG,EAAmB,CAAC,CAAC,gCAAgC;YACvE,CAAC;YAED,kBAAkB,EAAE,CAAC;YAErB,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,EAAE;gBAChC,IAAI,YAAY,IAAI,CAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,UAAU,MAAK,SAAS,CAAC,IAAI,EAAE,CAAC;oBAChE,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAC7B,CAAC;qBAAM,CAAC;oBACN,oFAAoF;oBACpF,qBAAqB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACtC,CAAC;YACH,CAAC,CAAC,CAAC;YACH,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,IAAY,EAAE,MAAc,EAAE,EAAE;gBACnD,MAAM,SAAS,GAAW,MAAM,CAAC,QAAQ,EAAE,IAAI,oBAAoB,CAAC;gBACpE,MAAM,eAAe,GAAW,uBAAuB,CAAC,IAAI,CAAC,CAAC;gBAC9D,MAAM,CAAC,cAAc,CACnB,yCAAyC,IAAI,KAAK,eAAe,cAAc,SAAS,EAAE,CAC3F,CAAC;gBACF,MAAM,CAAC,cAAc,CACnB,0BAA0B,YAAY,CAAC,CAAC,CAAC,4BAA4B,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAC/G,CAAC;gBACF,MAAM,CAAC,cAAc,CAAC,mBAAmB,YAAY,EAAE,CAAC,CAAC;YAC3D,CAAC,CAAC,CAAC;YACH,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAU,EAAE,EAAE;gBACjC,MAAM,CAAC,cAAc,CAAC,iCAAiC,wBAAwB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAC1F,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,4GAA4G;QAC5G,OAAO,CAAC;YACN,cAAc,EAAE,oBAAoB;YACpC,CAAC,MAAM,CAAC,OAAO,CAAC;gBACd,IAAI,CAAC;oBACH,cAAc,CAAC,KAAK,EAAE,CAAC;gBACzB,CAAC;gBAAC,WAAM,CAAC;oBACP,wDAAwD;gBAC1D,CAAC;gBACD,IAAI,CAAC;oBACH,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC/B,CAAC;gBAAC,WAAM,CAAC;oBACP,sDAAsD;gBACxD,CAAC;YACH,CAAC;YACD,+CAA+C;YAC/C,YAAY,EAAE,IAAI,OAAO,CAAO,CAAC,QAAQ,EAAE,EAAE;gBAC3C,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE;oBAChC,QAAQ,EAAE,CAAC;gBACb,CAAC,CAAC,CAAC;YACL,CAAC,CAAC;SACH,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport type { LaunchOptions } from 'playwright-core';\nimport playwrightPackageJson from 'playwright-core/package.json';\nimport type { RawData } from 'ws';\nimport { WebSocket, WebSocketServer } from 'ws';\n\nimport type { ITerminal } from '@rushstack/terminal';\n\nimport { HttpServer } from '../HttpServer';\nimport type { BrowserName } from '../PlaywrightBrowserTunnel';\nimport {\n  getNormalizedErrorString,\n  getWebSocketCloseReason,\n  getWebSocketReadyStateString,\n  WebSocketCloseCode\n} from '../utilities';\nimport type {\n  IDisposableTunneledBrowserConnection,\n  IHandshake,\n  IHandshakeAck\n} from './ITunneledBrowserConnection';\nimport { DEFAULT_LISTEN_PORT, SUPPORTED_BROWSER_NAMES } from './constants';\n\nconst { version: playwrightVersion } = playwrightPackageJson;\n\n/**\n * Creates a tunneled WebSocket endpoint that a local Playwright client can connect to.\n * @beta\n */\nexport async function tunneledBrowserConnection(\n  logger: ITerminal,\n  port: number = DEFAULT_LISTEN_PORT\n): Promise<IDisposableTunneledBrowserConnection> {\n  // Server that remote peer (actual browser host) connects to\n  const remoteWsServer: WebSocketServer = new WebSocketServer({ port });\n  // Local HTTP + WebSocket server where the playwright client will connect providing params\n  const httpServer: HttpServer = new HttpServer(logger);\n  await httpServer.listenAsync();\n  logger.writeLine(`Remote WebSocket server listening on ws://localhost:${port}`);\n\n  const localProxyWs: WebSocketServer = httpServer.wsServer;\n  const localProxyWsEndpoint: string = httpServer.endpoint;\n\n  let browserName: BrowserName | undefined;\n  let launchOptions: LaunchOptions | undefined;\n  let remoteSocket: WebSocket | undefined;\n  let handshakeAck: boolean = false;\n  let handshakeSent: boolean = false;\n\n  function maybeSendHandshake(): void {\n    if (!handshakeSent && remoteSocket && browserName && launchOptions) {\n      const handshake: IHandshake = {\n        action: 'handshake',\n        browserName,\n        launchOptions,\n        playwrightVersion\n      };\n      // Log handshake without 'headless' to avoid confusion (tunnel enforces headless: false)\n      // eslint-disable-next-line @typescript-eslint/no-unused-vars\n      const { headless, ...logOptions } = launchOptions;\n      const logHandshake: Omit<IHandshake, 'launchOptions'> & {\n        launchOptions: Omit<LaunchOptions, 'headless'>;\n      } = {\n        ...handshake,\n        launchOptions: logOptions\n      };\n      logger.writeLine(`Sending handshake to remote: ${JSON.stringify(logHandshake)}`);\n      handshakeSent = true;\n      remoteSocket.send(JSON.stringify(handshake));\n    }\n  }\n\n  return await new Promise((resolve) => {\n    remoteWsServer.on('error', (error) => {\n      logger.writeErrorLine(`Remote WebSocket server error: ${error}`);\n    });\n\n    remoteWsServer.on('close', () => {\n      logger.writeLine('Remote WebSocket server closed');\n    });\n\n    const bufferedLocalMessages: Array<RawData> = [];\n\n    remoteWsServer.on('connection', (ws) => {\n      logger.writeLine('Remote websocket connected');\n      remoteSocket = ws;\n      handshakeAck = false;\n      maybeSendHandshake();\n\n      ws.on('message', (message) => {\n        if (!handshakeAck) {\n          try {\n            const receivedHandshake: IHandshakeAck = JSON.parse(message.toString());\n            if (receivedHandshake.action === 'handshakeAck') {\n              handshakeAck = true;\n              logger.writeLine('Received handshakeAck from remote');\n            } else {\n              logger.writeErrorLine('Invalid handshake ack message');\n              ws.close(WebSocketCloseCode.PROTOCOL_ERROR, 'Invalid handshake ack');\n              return;\n            }\n          } catch (e) {\n            logger.writeErrorLine(`Failed parsing handshake ack: ${e}`);\n            ws.close(WebSocketCloseCode.PROTOCOL_ERROR, 'Failed parsing handshake');\n            return;\n          }\n          // Resolve only once local proxy available and handshake acknowledged\n          if (handshakeAck) {\n            // Flush any buffered local messages now that tunnel is active\n            const activeRemote: WebSocket | undefined = remoteSocket;\n            if (activeRemote && activeRemote.readyState === WebSocket.OPEN) {\n              while (bufferedLocalMessages.length > 0) {\n                const m: Buffer | ArrayBuffer | Buffer[] | string | undefined = bufferedLocalMessages.shift();\n                if (m !== undefined) {\n                  logger.writeLine(`Flushing buffered local message to remote: ${m}`);\n                  activeRemote.send(m);\n                }\n              }\n            }\n          }\n        } else {\n          // Forward from remote to all local clients\n          localProxyWs.clients.forEach((client) => {\n            if (client.readyState === WebSocket.OPEN) {\n              client.send(message);\n            }\n          });\n        }\n      });\n\n      ws.on('close', (code: number, reason: Buffer) => {\n        const reasonStr: string = reason.toString() || 'no reason provided';\n        const codeDescription: string = getWebSocketCloseReason(code);\n        logger.writeDebugLine(\n          `Remote websocket closed - code: ${code} (${codeDescription}), reason: ${reasonStr}`\n        );\n        logger.writeDebugLine(\n          `  Connection state at close: handshakeSent=${handshakeSent}, handshakeAck=${handshakeAck}`\n        );\n        logger.writeDebugLine(`  Buffered messages pending: ${bufferedLocalMessages.length}`);\n      });\n      ws.on('error', (err: Error) => {\n        logger.writeErrorLine(`Remote websocket error: ${getNormalizedErrorString(err)}`);\n        logger.writeErrorLine(`  Socket readyState: ${getWebSocketReadyStateString(ws.readyState)}`);\n      });\n    });\n\n    localProxyWs.on('connection', (localWs, request) => {\n      try {\n        const urlString: string | undefined = request?.url;\n        if (urlString) {\n          const parsed: URL = new URL(urlString, 'http://localhost');\n          logger.writeLine(`Local client connected with query params: ${parsed.searchParams.toString()}`);\n          const bName: string | null = parsed.searchParams.get('browser');\n          if (bName && SUPPORTED_BROWSER_NAMES.has(bName)) {\n            browserName = bName as BrowserName;\n          }\n          const launchOptionsParam: string | null = parsed.searchParams.get('launchOptions');\n          if (launchOptionsParam) {\n            try {\n              launchOptions = JSON.parse(launchOptionsParam);\n            } catch (e) {\n              logger.writeErrorLine('Invalid launchOptions JSON provided');\n            }\n          }\n        }\n      } catch (e) {\n        logger.writeErrorLine(`Error parsing local connection query params: ${e}`);\n      }\n\n      if (!browserName) {\n        const supportedBrowsersString: string = Array.from(SUPPORTED_BROWSER_NAMES).join('|');\n        logger.writeErrorLine(`browser query param required (${supportedBrowsersString})`);\n        localWs.close(WebSocketCloseCode.PROTOCOL_ERROR, 'Missing browser param');\n        return;\n      }\n      if (!launchOptions) {\n        launchOptions = {} as LaunchOptions; // default empty if not provided\n      }\n\n      maybeSendHandshake();\n\n      localWs.on('message', (message) => {\n        if (handshakeAck && remoteSocket?.readyState === WebSocket.OPEN) {\n          remoteSocket.send(message);\n        } else {\n          // Buffer until handshakeAck to avoid losing early protocol messages from Playwright\n          bufferedLocalMessages.push(message);\n        }\n      });\n      localWs.on('close', (code: number, reason: Buffer) => {\n        const reasonStr: string = reason.toString() || 'no reason provided';\n        const codeDescription: string = getWebSocketCloseReason(code);\n        logger.writeDebugLine(\n          `Local client websocket closed - code: ${code} (${codeDescription}), reason: ${reasonStr}`\n        );\n        logger.writeDebugLine(\n          `  Remote socket state: ${remoteSocket ? getWebSocketReadyStateString(remoteSocket.readyState) : 'undefined'}`\n        );\n        logger.writeDebugLine(`  handshakeAck: ${handshakeAck}`);\n      });\n      localWs.on('error', (err: Error) => {\n        logger.writeErrorLine(`Local client websocket error: ${getNormalizedErrorString(err)}`);\n      });\n    });\n\n    // Resolve immediately so caller can initiate local connection with query params (handshake completes later)\n    resolve({\n      remoteEndpoint: localProxyWsEndpoint,\n      [Symbol.dispose]() {\n        try {\n          remoteWsServer.close();\n        } catch {\n          // ignore errors during remote WebSocket server shutdown\n        }\n        try {\n          httpServer[Symbol.dispose]();\n        } catch {\n          // ignore errors during HTTP/WebSocket server shutdown\n        }\n      },\n      // eslint-disable-next-line promise/param-names\n      closePromise: new Promise<void>((resolve2) => {\n        remoteWsServer.once('close', () => {\n          resolve2();\n        });\n      })\n    });\n  });\n}\n"]}

package/lib-esm/tunneledBrowserConnection/constants.js

@@ -0,0 +1,5 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+export const SUPPORTED_BROWSER_NAMES = new Set(['chromium', 'firefox', 'webkit']);
+export const DEFAULT_LISTEN_PORT = 56767;
+//# sourceMappingURL=constants.js.map

package/lib-esm/tunneledBrowserConnection/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/tunneledBrowserConnection/constants.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,MAAM,CAAC,MAAM,uBAAuB,GAAgB,IAAI,GAAG,CAAC,CAAC,UAAU,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC;AAC/F,MAAM,CAAC,MAAM,mBAAmB,GAAW,KAAK,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nexport const SUPPORTED_BROWSER_NAMES: Set<string> = new Set(['chromium', 'firefox', 'webkit']);\nexport const DEFAULT_LISTEN_PORT: number = 56767;\n"]}

package/lib-esm/tunneledBrowserConnection/index.js

@@ -0,0 +1,5 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+export { createTunneledBrowserAsync } from './TunneledBrowser';
+export { tunneledBrowserConnection } from './TunneledBrowserConnection';
+//# sourceMappingURL=index.js.map

package/lib-esm/tunneledBrowserConnection/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/tunneledBrowserConnection/index.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EAAE,0BAA0B,EAAE,MAAM,mBAAmB,CAAC;AAC/D,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nexport { createTunneledBrowserAsync } from './TunneledBrowser';\nexport { tunneledBrowserConnection } from './TunneledBrowserConnection';\n\nexport type { IDisposableTunneledBrowser } from './ITunneledBrowser';\nexport type { IDisposableTunneledBrowserConnection } from './ITunneledBrowserConnection';\n"]}

package/lib-esm/utilities.js

@@ -0,0 +1,96 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+import { tmpdir } from 'node:os';
+import { FileSystem } from '@rushstack/node-core-library';
+/**
+ * The filename used to indicate that the Playwright Local Browser Server extension is installed.
+ * @beta
+ */
+export const EXTENSION_INSTALLED_FILENAME = '.playwright-local-browser-server-extension-installed.txt';
+/**
+ * Helper to determine if the Playwright Local Browser Server extension is installed. This checks for the
+ * existence of a well-known file in the OS temp directory.
+ * @beta
+ */
+export async function isExtensionInstalledAsync() {
+    // Read file from os.tempdir() + '/.playwright-local-browser-server-extension-installed'
+    const tempDir = tmpdir();
+    const extensionInstalledFilePath = `${tempDir}/${EXTENSION_INSTALLED_FILENAME}`;
+    const doesExist = FileSystem.exists(extensionInstalledFilePath);
+    // check if file exists
+    return doesExist;
+}
+/**
+ * Normalizes an error to a string for logging purposes.
+ * @beta
+ */
+export function getNormalizedErrorString(error) {
+    if (error instanceof Error) {
+        if (error.stack) {
+            return error.stack;
+        }
+        return error.message;
+    }
+    return String(error);
+}
+/**
+ * WebSocket close codes as defined by RFC 6455.
+ * @see {@link https://datatracker.ietf.org/doc/html/rfc6455#section-11.7}
+ * @beta
+ */
+export const WebSocketCloseCode = {
+    NORMAL_CLOSURE: 1000,
+    GOING_AWAY: 1001,
+    PROTOCOL_ERROR: 1002,
+    UNSUPPORTED_DATA: 1003,
+    NO_STATUS_RECEIVED: 1005,
+    ABNORMAL_CLOSURE: 1006,
+    INVALID_PAYLOAD: 1007,
+    POLICY_VIOLATION: 1008,
+    MESSAGE_TOO_BIG: 1009,
+    INTERNAL_ERROR: 1011,
+    TLS_HANDSHAKE_FAILED: 1015
+};
+/**
+ * Human-readable descriptions for WebSocket close codes.
+ * @beta
+ */
+export const WebSocketCloseCodeDescriptions = {
+    [WebSocketCloseCode.NORMAL_CLOSURE]: 'Normal Closure',
+    [WebSocketCloseCode.GOING_AWAY]: 'Going Away',
+    [WebSocketCloseCode.PROTOCOL_ERROR]: 'Protocol Error',
+    [WebSocketCloseCode.UNSUPPORTED_DATA]: 'Unsupported Data',
+    [WebSocketCloseCode.NO_STATUS_RECEIVED]: 'No Status Received',
+    [WebSocketCloseCode.ABNORMAL_CLOSURE]: 'Abnormal Closure (connection lost)',
+    [WebSocketCloseCode.INVALID_PAYLOAD]: 'Invalid Payload',
+    [WebSocketCloseCode.POLICY_VIOLATION]: 'Policy Violation',
+    [WebSocketCloseCode.MESSAGE_TOO_BIG]: 'Message Too Big',
+    [WebSocketCloseCode.INTERNAL_ERROR]: 'Internal Error',
+    [WebSocketCloseCode.TLS_HANDSHAKE_FAILED]: 'TLS Handshake Failed'
+};
+/**
+ * Returns a human-readable description for a WebSocket close code.
+ * @beta
+ */
+export function getWebSocketCloseReason(code) {
+    return WebSocketCloseCodeDescriptions[code] || 'Unknown';
+}
+/**
+ * Returns a human-readable string for a WebSocket ready state.
+ * @beta
+ */
+export function getWebSocketReadyStateString(readyState) {
+    switch (readyState) {
+        case 0:
+            return 'CONNECTING';
+        case 1:
+            return 'OPEN';
+        case 2:
+            return 'CLOSING';
+        case 3:
+            return 'CLOSED';
+        default:
+            return `UNKNOWN(${readyState})`;
+    }
+}
+//# sourceMappingURL=utilities.js.map

package/lib-esm/utilities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utilities.js","sourceRoot":"","sources":["../src/utilities.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,2DAA2D;AAE3D,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEjC,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAE1D;;;GAGG;AACH,MAAM,CAAC,MAAM,4BAA4B,GACvC,0DAA0D,CAAC;AAE7D;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,yBAAyB;IAC7C,wFAAwF;IACxF,MAAM,OAAO,GAAW,MAAM,EAAE,CAAC;IAEjC,MAAM,0BAA0B,GAAW,GAAG,OAAO,IAAI,4BAA4B,EAAE,CAAC;IACxF,MAAM,SAAS,GAAY,UAAU,CAAC,MAAM,CAAC,0BAA0B,CAAC,CAAC;IAEzE,uBAAuB;IACvB,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,wBAAwB,CAAC,KAAc;IACrD,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;QAC3B,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;YAChB,OAAO,KAAK,CAAC,KAAK,CAAC;QACrB,CAAC;QACD,OAAO,KAAK,CAAC,OAAO,CAAC;IACvB,CAAC;IACD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;AACvB,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAuB3B;IACF,cAAc,EAAE,IAAI;IACpB,UAAU,EAAE,IAAI;IAChB,cAAc,EAAE,IAAI;IACpB,gBAAgB,EAAE,IAAI;IACtB,kBAAkB,EAAE,IAAI;IACxB,gBAAgB,EAAE,IAAI;IACtB,eAAe,EAAE,IAAI;IACrB,gBAAgB,EAAE,IAAI;IACtB,eAAe,EAAE,IAAI;IACrB,cAAc,EAAE,IAAI;IACpB,oBAAoB,EAAE,IAAI;CAC3B,CAAC;AAQF;;;GAGG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAA4C;IACrF,CAAC,kBAAkB,CAAC,cAAc,CAAC,EAAE,gBAAgB;IACrD,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE,YAAY;IAC7C,CAAC,kBAAkB,CAAC,cAAc,CAAC,EAAE,gBAAgB;IACrD,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,EAAE,kBAAkB;IACzD,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,EAAE,oBAAoB;IAC7D,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,EAAE,oCAAoC;IAC3E,CAAC,kBAAkB,CAAC,eAAe,CAAC,EAAE,iBAAiB;IACvD,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,EAAE,kBAAkB;IACzD,CAAC,kBAAkB,CAAC,eAAe,CAAC,EAAE,iBAAiB;IACvD,CAAC,kBAAkB,CAAC,cAAc,CAAC,EAAE,gBAAgB;IACrD,CAAC,kBAAkB,CAAC,oBAAoB,CAAC,EAAE,sBAAsB;CAClE,CAAC;AAEF;;;GAGG;AACH,MAAM,UAAU,uBAAuB,CAAC,IAAY;IAClD,OAAO,8BAA8B,CAAC,IAA+B,CAAC,IAAI,SAAS,CAAC;AACtF,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,4BAA4B,CAAC,UAAkB;IAC7D,QAAQ,UAAU,EAAE,CAAC;QACnB,KAAK,CAAC;YACJ,OAAO,YAAY,CAAC;QACtB,KAAK,CAAC;YACJ,OAAO,MAAM,CAAC;QAChB,KAAK,CAAC;YACJ,OAAO,SAAS,CAAC;QACnB,KAAK,CAAC;YACJ,OAAO,QAAQ,CAAC;QAClB;YACE,OAAO,WAAW,UAAU,GAAG,CAAC;IACpC,CAAC;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport { tmpdir } from 'node:os';\n\nimport { FileSystem } from '@rushstack/node-core-library';\n\n/**\n * The filename used to indicate that the Playwright Local Browser Server extension is installed.\n * @beta\n */\nexport const EXTENSION_INSTALLED_FILENAME: string =\n  '.playwright-local-browser-server-extension-installed.txt';\n\n/**\n * Helper to determine if the Playwright Local Browser Server extension is installed. This checks for the\n * existence of a well-known file in the OS temp directory.\n * @beta\n */\nexport async function isExtensionInstalledAsync(): Promise<boolean> {\n  // Read file from os.tempdir() + '/.playwright-local-browser-server-extension-installed'\n  const tempDir: string = tmpdir();\n\n  const extensionInstalledFilePath: string = `${tempDir}/${EXTENSION_INSTALLED_FILENAME}`;\n  const doesExist: boolean = FileSystem.exists(extensionInstalledFilePath);\n\n  // check if file exists\n  return doesExist;\n}\n\n/**\n * Normalizes an error to a string for logging purposes.\n * @beta\n */\nexport function getNormalizedErrorString(error: unknown): string {\n  if (error instanceof Error) {\n    if (error.stack) {\n      return error.stack;\n    }\n    return error.message;\n  }\n  return String(error);\n}\n\n/**\n * WebSocket close codes as defined by RFC 6455.\n * @see {@link https://datatracker.ietf.org/doc/html/rfc6455#section-11.7}\n * @beta\n */\nexport const WebSocketCloseCode: {\n  /** Normal closure; the connection successfully completed. */\n  readonly NORMAL_CLOSURE: 1000;\n  /** Endpoint is going away (e.g., server shutting down, browser navigating away). */\n  readonly GOING_AWAY: 1001;\n  /** Protocol error encountered. */\n  readonly PROTOCOL_ERROR: 1002;\n  /** Received data type that cannot be accepted (e.g., text-only endpoint received binary). */\n  readonly UNSUPPORTED_DATA: 1003;\n  /** No status code was provided even though one was expected. */\n  readonly NO_STATUS_RECEIVED: 1005;\n  /** Connection was closed abnormally (e.g., without sending a close frame). */\n  readonly ABNORMAL_CLOSURE: 1006;\n  /** Received message data inconsistent with the message type. */\n  readonly INVALID_PAYLOAD: 1007;\n  /** Received a message that violates policy. */\n  readonly POLICY_VIOLATION: 1008;\n  /** Received a message that is too big to process. */\n  readonly MESSAGE_TOO_BIG: 1009;\n  /** Server encountered an unexpected condition that prevented it from fulfilling the request. */\n  readonly INTERNAL_ERROR: 1011;\n  /** Connection was closed due to TLS handshake failure. */\n  readonly TLS_HANDSHAKE_FAILED: 1015;\n} = {\n  NORMAL_CLOSURE: 1000,\n  GOING_AWAY: 1001,\n  PROTOCOL_ERROR: 1002,\n  UNSUPPORTED_DATA: 1003,\n  NO_STATUS_RECEIVED: 1005,\n  ABNORMAL_CLOSURE: 1006,\n  INVALID_PAYLOAD: 1007,\n  POLICY_VIOLATION: 1008,\n  MESSAGE_TOO_BIG: 1009,\n  INTERNAL_ERROR: 1011,\n  TLS_HANDSHAKE_FAILED: 1015\n};\n\n/**\n * Type for WebSocket close code values.\n * @beta\n */\nexport type WebSocketCloseCodeValue = (typeof WebSocketCloseCode)[keyof typeof WebSocketCloseCode];\n\n/**\n * Human-readable descriptions for WebSocket close codes.\n * @beta\n */\nexport const WebSocketCloseCodeDescriptions: Record<WebSocketCloseCodeValue, string> = {\n  [WebSocketCloseCode.NORMAL_CLOSURE]: 'Normal Closure',\n  [WebSocketCloseCode.GOING_AWAY]: 'Going Away',\n  [WebSocketCloseCode.PROTOCOL_ERROR]: 'Protocol Error',\n  [WebSocketCloseCode.UNSUPPORTED_DATA]: 'Unsupported Data',\n  [WebSocketCloseCode.NO_STATUS_RECEIVED]: 'No Status Received',\n  [WebSocketCloseCode.ABNORMAL_CLOSURE]: 'Abnormal Closure (connection lost)',\n  [WebSocketCloseCode.INVALID_PAYLOAD]: 'Invalid Payload',\n  [WebSocketCloseCode.POLICY_VIOLATION]: 'Policy Violation',\n  [WebSocketCloseCode.MESSAGE_TOO_BIG]: 'Message Too Big',\n  [WebSocketCloseCode.INTERNAL_ERROR]: 'Internal Error',\n  [WebSocketCloseCode.TLS_HANDSHAKE_FAILED]: 'TLS Handshake Failed'\n};\n\n/**\n * Returns a human-readable description for a WebSocket close code.\n * @beta\n */\nexport function getWebSocketCloseReason(code: number): string {\n  return WebSocketCloseCodeDescriptions[code as WebSocketCloseCodeValue] || 'Unknown';\n}\n\n/**\n * Returns a human-readable string for a WebSocket ready state.\n * @beta\n */\nexport function getWebSocketReadyStateString(readyState: number): string {\n  switch (readyState) {\n    case 0:\n      return 'CONNECTING';\n    case 1:\n      return 'OPEN';\n    case 2:\n      return 'CLOSING';\n    case 3:\n      return 'CLOSED';\n    default:\n      return `UNKNOWN(${readyState})`;\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/playwright-browser-tunnel",
-  "version": "0.2.4",
+  "version": "0.3.0",
   "description": "Run a remote Playwright Browser Tunnel. Useful in remote development environments.",
   "license": "MIT",
   "repository": {
@@ -8,7 +8,29 @@
     "url": "https://github.com/microsoft/rushstack.git",
     "directory": "apps/playwright-browser-tunnel"
   },
-  "main": "lib/index.js",
+  "main": "./lib-commonjs/index.js",
+  "module": "./lib-esm/index.js",
+  "types": "./lib-dts/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib-dts/index.d.ts",
+      "import": "./lib-esm/index.js",
+      "require": "./lib-commonjs/index.js"
+    },
+    "./lib/*": {
+      "types": "./lib-dts/*.d.ts",
+      "import": "./lib-esm/*.js",
+      "require": "./lib-commonjs/*.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "typesVersions": {
+    "*": {
+      "lib/*": [
+        "lib-dts/*"
+      ]
+    }
+  },
   "engines": {
     "node": ">=20.0.0"
   },
@@ -19,9 +41,9 @@
     "semver": "~7.5.4",
     "ws": "~8.14.1",
     "playwright": "1.56.1",
-    "@rushstack/terminal": "0.21.0",
-    "@rushstack/ts-command-line": "5.2.0",
-    "@rushstack/node-core-library": "5.19.1"
+    "@rushstack/terminal": "0.22.0",
+    "@rushstack/node-core-library": "5.20.0",
+    "@rushstack/ts-command-line": "5.3.0"
   },
   "devDependencies": {
     "eslint": "~9.37.0",
@@ -30,12 +52,13 @@
     "playwright-core": "~1.56.1",
     "@playwright/test": "~1.56.1",
     "@types/node": "20.17.19",
-    "@rushstack/heft": "1.1.14",
+    "@rushstack/heft": "1.2.0",
     "local-node-rig": "1.0.0"
   },
   "peerDependencies": {
     "playwright-core": "~1.56.1"
   },
+  "sideEffects": false,
   "scripts": {
     "build": "heft build --clean",
     "_phase:build": "heft run --only build -- --clean",

package/rush-logs/playwright-browser-tunnel._phase_build.cache.log

@@ -1,3 +1,3 @@
-Caching build output folders: dist, lib, temp, .rush/temp/operation/_phase_build
+Caching build output folders: dist, lib-commonjs, temp, lib-dts, lib-esm, .rush/temp/operation/_phase_build
 Successfully set cache entry.
-Cache key: rushstack+playwright-browser-tunnel-_phase_build-517a2999ebe527b217bbfe2e265943b73bf3856b
+Cache key: rushstack+playwright-browser-tunnel-_phase_build-7739ed2cac57efca3ad3fa4de550f08e1f482854

package/rush-logs/playwright-browser-tunnel._phase_build.log

@@ -4,5 +4,5 @@ Invoking: heft run --only build -- --clean --production
 [build:lint] Using ESLint version 9.37.0
 [build:api-extractor] Using API Extractor version 7.56.3
 [build:api-extractor] Analysis will use the bundled TypeScript version 5.8.2
- ---- build finished (22.551s) ---- 
--------------------- Finished (22.555s) --------------------
+ ---- build finished (22.938s) ---- 
+-------------------- Finished (22.943s) --------------------