Add todos and update version

Author: TheLarkInn

apps/playwright-browser-tunnel/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/playwright-browser-tunnel",
-  "version": "0.0.0",
+  "version": "0.0.1",
   "description": "Run a remote Playwright Browser Tunnel. Useful in remote development environments.",
   "repository": {
     "type": "git",

apps/playwright-browser-tunnel/src/PlaywrightBrowserTunnel.ts

@@ -156,6 +156,7 @@ export class PlaywrightTunnel {
     }
   }
 
+  // TODO: This is not used but we should use this in a vscode command to perform cleanup.
   public async uninstallPlaywrightBrowsersAsync(): Promise<void> {
     try {
       const playwrightVersion: semver.SemVer | null = semver.coerce('latest');
@@ -208,6 +209,8 @@ export class PlaywrightTunnel {
     await Executable.waitForExitAsync(cp);
   }
 
+  // TODO: Add a installation cache to avoid reinstalling same version multiple times
+  // Map which stores the state of installed playwright-core versions
   private async _installPlaywrightCoreAsync({
     playwrightVersion
   }: Pick<IHandshake, 'playwrightVersion'>): Promise<void> {
@@ -248,6 +251,8 @@ export class PlaywrightTunnel {
     });
   }
 
+  // TODO: Only supporting one test at a time.
+  // Need to support multiple simultaneous connections for parallel tests.
   private async _pollConnectionAsync(): Promise<WebSocket> {
     this._terminal.writeLine(`Waiting for WebSocket connection`);
     return new Promise((resolve, reject) => {
@@ -367,6 +372,7 @@ export class PlaywrightTunnel {
     };
   }
 
+  // ws1 is the tunnel websocket, ws2 is the browser server websocket
   private async _setupForwardingAsync(ws1: WebSocket, ws2: WebSocket): Promise<void> {
     console.log('Setting up message forwarding between ws1 and ws2');
     ws1.on('message', (data) => {

apps/playwright-browser-tunnel/src/tunneledBrowserConnection.ts

@@ -42,6 +42,7 @@ class HttpServer {
     return new Promise((resolve) => {
       this._server.listen(0, '127.0.0.1', () => {
         this._listeningPort = (this._server.address() as AddressInfo).port;
+        // This MUST be printed to terminal so VS Code can auto-port forward
         console.log(`Local proxy HttpServer listening at ws://127.0.0.1:${this._listeningPort}`);
         resolve();
       });