chore(ssh-tunnel): add logging and improve displayed error message COMPASS-7336 (#4983)

Author: addaleax

package-lock.json

@@ -48,7 +48,7 @@
     "reformat": "npm run prettier -- --write . && npm run eslint . --fix"
   },
   "dependencies": {
-    "debug": "^4.2.0",
+    "debug": "^4.3.4",
     "is-electron-renderer": "^2.0.1",
     "mongodb-log-writer": "^1.3.0"
   },
@@ -57,6 +57,7 @@
     "@mongodb-js/mocha-config-compass": "^1.3.1",
     "@mongodb-js/prettier-config-compass": "^1.0.1",
     "@mongodb-js/tsconfig-compass": "^1.0.3",
+    "@types/debug": "^4.1.9",
     "@types/chai": "^4.2.21",
     "@types/mocha": "^9.0.0",
     "@types/sinon-chai": "^3.2.5",

packages/compass-logging/package.json

@@ -161,6 +161,10 @@ export async function connectMongoClientDataService({
     connectionOptions.sshTunnel,
     logger
   );
+  const tunnelForwardingErrors: Error[] = [];
+  tunnel?.on('forwardingError', (err: Error) =>
+    tunnelForwardingErrors.push(err)
+  );
 
   if (socks5Options) {
     Object.assign(options, socks5Options);
@@ -280,6 +284,13 @@ export async function connectMongoClientDataService({
     ]).catch(() => {
       /* ignore errors */
     });
+    if (tunnelForwardingErrors.length > 0) {
+      err.message = `${
+        err.message
+      } [SSH Tunnel errors: ${tunnelForwardingErrors.map(
+        (err) => err.message
+      )}]`;
+    }
     throw err;
   }
 }

packages/data-service/src/connect-mongo-client.ts

@@ -55,7 +55,6 @@
     "@mongodb-js/tsconfig-compass": "^1.0.3",
     "@types/chai": "^4.2.21",
     "@types/chai-as-promised": "^7.1.4",
-    "@types/debug": "^4.1.7",
     "@types/mocha": "^9.0.0",
     "@types/node-fetch": "^2.5.8",
     "@types/sinon-chai": "^3.2.5",
@@ -74,7 +73,7 @@
     "typescript": "^5.0.4"
   },
   "dependencies": {
-    "debug": "^4.2.0",
+    "@mongodb-js/compass-logging": "^1.2.2",
     "socksv5": "0.0.6",
     "ssh2": "^1.12.0"
   }