@rushstack/playwright-browser-tunnel 0.2.3 → 0.2.4

package/src/tunneledBrowserConnection/TunneledBrowser.ts

@@ -0,0 +1,52 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+import type { Browser, LaunchOptions } from 'playwright-core';
+import playwright from 'playwright-core';
+
+import type { ITerminal } from '@rushstack/terminal';
+import { ConsoleTerminalProvider, Terminal } from '@rushstack/terminal';
+
+import type { BrowserName } from '../PlaywrightBrowserTunnel';
+import { DEFAULT_LISTEN_PORT } from './constants';
+import type { IDisposableTunneledBrowser } from './ITunneledBrowser';
+import type { IDisposableTunneledBrowserConnection } from './ITunneledBrowserConnection';
+import { tunneledBrowserConnection } from './TunneledBrowserConnection';
+
+/**
+ * Creates a Playwright Browser instance connected via a tunneled WebSocket connection.
+ * @beta
+ */
+export async function createTunneledBrowserAsync(
+  browserName: BrowserName,
+  launchOptions: LaunchOptions,
+  logger?: ITerminal,
+  port: number = DEFAULT_LISTEN_PORT
+): Promise<IDisposableTunneledBrowser> {
+  // Establish the tunnel first (remoteEndpoint here refers to local proxy endpoint for connect())
+
+  if (!logger) {
+    const terminalProvider: ConsoleTerminalProvider = new ConsoleTerminalProvider();
+    logger = new Terminal(terminalProvider);
+  }
+
+  const connection: IDisposableTunneledBrowserConnection = await tunneledBrowserConnection(logger, port);
+  const { remoteEndpoint } = connection;
+  // Append query params for browser and launchOptions
+  const urlObj: URL = new URL(remoteEndpoint);
+  urlObj.searchParams.set('browser', browserName);
+  urlObj.searchParams.set('launchOptions', JSON.stringify(launchOptions || {}));
+  const connectEndpoint: string = urlObj.toString();
+  const browser: 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]();
+    }
+  };
+}

package/src/{tunneledBrowserConnection.ts → tunneledBrowserConnection/TunneledBrowserConnection.ts}

@@ -1,59 +1,30 @@
 // 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 type { Browser, LaunchOptions } from 'playwright-core';
-import { WebSocketServer, WebSocket, type RawData } from 'ws';
+import type { LaunchOptions } from 'playwright-core';
 import playwrightPackageJson from 'playwright-core/package.json';
+import type { RawData } from 'ws';
+import { WebSocket, WebSocketServer } from 'ws';
 
-import { type ITerminal, Terminal, ConsoleTerminalProvider } from '@rushstack/terminal';
+import type { ITerminal } from '@rushstack/terminal';
 
-import type { BrowserName } from './PlaywrightBrowserTunnel';
-import { HttpServer } from './HttpServer';
+import { HttpServer } from '../HttpServer';
+import type { BrowserName } from '../PlaywrightBrowserTunnel';
 import {
   getNormalizedErrorString,
   getWebSocketCloseReason,
   getWebSocketReadyStateString,
   WebSocketCloseCode
-} from './utilities';
+} from '../utilities';
+import type {
+  IDisposableTunneledBrowserConnection,
+  IHandshake,
+  IHandshakeAck
+} from './ITunneledBrowserConnection';
+import { DEFAULT_LISTEN_PORT, SUPPORTED_BROWSER_NAMES } from './constants';
 
 const { version: playwrightVersion } = playwrightPackageJson;
 
-const SUPPORTED_BROWSER_NAMES: Set<string> = new Set(['chromium', 'firefox', 'webkit']);
-
-interface IHandshake {
-  action: 'handshake';
-  browserName: BrowserName;
-  launchOptions: LaunchOptions;
-  playwrightVersion: string;
-}
-
-interface IHandshakeAck {
-  action: 'handshakeAck';
-}
-
-const DEFAULT_LISTEN_PORT: number = 56767;
-
-/**
- * Disposable handle returned by {@link tunneledBrowserConnection}.
- * @beta
- */
-export interface IDisposableTunneledBrowserConnection {
-  /**
-   * The WebSocket endpoint URL that the local Playwright client should connect to.
-   */
-  remoteEndpoint: string;
-  /**
-   * Dispose method that closes the WebSocket servers.
-   * Called automatically when using `using` syntax.
-   */
-  [Symbol.dispose]: () => void;
-  /**
-   * Promise that resolves when the remote WebSocket server closes.
-   */
-  closePromise: Promise<void>;
-}
-
 /**
  * Creates a tunneled WebSocket endpoint that a local Playwright client can connect to.
  * @beta
@@ -259,57 +230,3 @@ export async function tunneledBrowserConnection(
     });
   });
 }
-
-/**
- * Disposable handle returned by {@link createTunneledBrowserAsync}.
- * @beta
- */
-export interface IDisposableTunneledBrowser {
-  /**
-   * The connected Playwright Browser instance.
-   */
-  browser: Browser;
-  /**
-   * Async dispose method that closes the browser connection.
-   * Called automatically when using `await using` syntax.
-   */
-  [Symbol.asyncDispose]: () => Promise<void>;
-}
-
-/**
- * Creates a Playwright Browser instance connected via a tunneled WebSocket connection.
- * @beta
- */
-export async function createTunneledBrowserAsync(
-  browserName: BrowserName,
-  launchOptions: LaunchOptions,
-  logger?: ITerminal,
-  port: number = DEFAULT_LISTEN_PORT
-): Promise<IDisposableTunneledBrowser> {
-  // Establish the tunnel first (remoteEndpoint here refers to local proxy endpoint for connect())
-
-  if (!logger) {
-    const terminalProvider: ConsoleTerminalProvider = new ConsoleTerminalProvider();
-    logger = new Terminal(terminalProvider);
-  }
-
-  const connection: IDisposableTunneledBrowserConnection = await tunneledBrowserConnection(logger, port);
-  const { remoteEndpoint } = connection;
-  // Append query params for browser and launchOptions
-  const urlObj: URL = new URL(remoteEndpoint);
-  urlObj.searchParams.set('browser', browserName);
-  urlObj.searchParams.set('launchOptions', JSON.stringify(launchOptions || {}));
-  const connectEndpoint: string = urlObj.toString();
-  const browser: 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]();
-    }
-  };
-}

package/src/tunneledBrowserConnection/constants.ts

@@ -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: Set<string> = new Set(['chromium', 'firefox', 'webkit']);
+export const DEFAULT_LISTEN_PORT: number = 56767;

package/src/tunneledBrowserConnection/index.ts

@@ -0,0 +1,8 @@
+// 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';
+
+export type { IDisposableTunneledBrowser } from './ITunneledBrowser';
+export type { IDisposableTunneledBrowserConnection } from './ITunneledBrowserConnection';

package/temp/build/lint/_eslint-5eVG3S6w.json

@@ -18,13 +18,33 @@
       "1bbea2c477cd1510d00e14a14fbec331f491dd2f058e2146671cb08385da8e09_Q57tkjZtaaMkmlD1DBUjScEtgSo="
     ],
     [
-      "tunneledBrowserConnection.ts",
-      "b5d386ebe95ede96636a3c5449b8e375f128cfb6c22d45af107c3a9294e161be_Q57tkjZtaaMkmlD1DBUjScEtgSo="
+      "tunneledBrowserConnection/constants.ts",
+      "869309171fd2db0c9aaeb1003be41243d026b23c1715de8e53afe8b30edd1f39_Q57tkjZtaaMkmlD1DBUjScEtgSo="
+    ],
+    [
+      "tunneledBrowserConnection/ITunneledBrowser.ts",
+      "f69368b63d693a2c39804340262e6f4262c44a3cba1a73ee34084634d44fd4ef_Q57tkjZtaaMkmlD1DBUjScEtgSo="
+    ],
+    [
+      "tunneledBrowserConnection/ITunneledBrowserConnection.ts",
+      "0a38e3d400fbbaa2c2e46c7671791a21a6ca5f64c6e0179cb6763f66fd2be8d3_Q57tkjZtaaMkmlD1DBUjScEtgSo="
+    ],
+    [
+      "tunneledBrowserConnection/TunneledBrowserConnection.ts",
+      "9b61eeb3223a7e24a6cece972a31c4ec06cf8d517b5c686fe24a5708642306b6_Q57tkjZtaaMkmlD1DBUjScEtgSo="
+    ],
+    [
+      "tunneledBrowserConnection/TunneledBrowser.ts",
+      "2b1763d3a9069360f0eaf654d86c9a147e749f51a0622530606519472af1ed61_Q57tkjZtaaMkmlD1DBUjScEtgSo="
+    ],
+    [
+      "tunneledBrowserConnection/index.ts",
+      "7120be95e2c956b5b31ec8dc46a2824b0bf8058f36ea7a43ac60c1ccad23dca2_Q57tkjZtaaMkmlD1DBUjScEtgSo="
     ],
     [
       "index.ts",
       "24a883b07dbd0c309fa5f83653a48f3ac849200808fbe3872f34b11c99ea1668_Q57tkjZtaaMkmlD1DBUjScEtgSo="
     ]
   ],
-  "filesHash": "veFIt5t1iWa1vWcPeyJW4Q"
+  "filesHash": "yJgnU3yxb7-XPq6SpVUP-w"
 }

package/temp/build/lint/lint.sarif

@@ -67,7 +67,32 @@
         },
         {
           "location": {
-            "uri": "src/tunneledBrowserConnection.ts"
+            "uri": "src/tunneledBrowserConnection/constants.ts"
+          }
+        },
+        {
+          "location": {
+            "uri": "src/tunneledBrowserConnection/ITunneledBrowser.ts"
+          }
+        },
+        {
+          "location": {
+            "uri": "src/tunneledBrowserConnection/ITunneledBrowserConnection.ts"
+          }
+        },
+        {
+          "location": {
+            "uri": "src/tunneledBrowserConnection/TunneledBrowserConnection.ts"
+          }
+        },
+        {
+          "location": {
+            "uri": "src/tunneledBrowserConnection/TunneledBrowser.ts"
+          }
+        },
+        {
+          "location": {
+            "uri": "src/tunneledBrowserConnection/index.ts"
           }
         },
         {
@@ -176,13 +201,13 @@
             {
               "physicalLocation": {
                 "artifactLocation": {
-                  "uri": "src/tunneledBrowserConnection.ts",
-                  "index": 4
+                  "uri": "src/tunneledBrowserConnection/TunneledBrowserConnection.ts",
+                  "index": 7
                 },
                 "region": {
-                  "startLine": 91,
+                  "startLine": 62,
                   "startColumn": 15,
-                  "endLine": 91,
+                  "endLine": 62,
                   "endColumn": 23
                 }
               }
@@ -206,13 +231,13 @@
             {
               "physicalLocation": {
                 "artifactLocation": {
-                  "uri": "src/tunneledBrowserConnection.ts",
-                  "index": 4
+                  "uri": "src/tunneledBrowserConnection/TunneledBrowserConnection.ts",
+                  "index": 7
                 },
                 "region": {
-                  "startLine": 254,
+                  "startLine": 225,
                   "startColumn": 40,
-                  "endLine": 254,
+                  "endLine": 225,
                   "endColumn": 48
                 }
               }