fix: Update ssh-tunnel mock to match new implementation

Author: gribnoysup

lib/connect.js

@@ -240,7 +240,20 @@ const getTasks = (model, setupListeners) => {
         setupListeners(mongoClient);
       }
 
+      let maybeTunnelError;
+
+      if (tunnel) {
+        tunnel.on('error', (tunnelError) => {
+          maybeTunnelError = tunnelError;
+        });
+      }
+
       mongoClient.connect((err, _client) => {
+        // When mongo client failed to connect AND tunnel encountered an error
+        // those two are totally related and we want to return a tunnel error as
+        // it will have more relevant context for the end user
+        err = err && maybeTunnelError ? maybeTunnelError : err;
+
         ctx(err);
 
         if (err) {

package.json

@@ -16,7 +16,7 @@
   "scripts": {
     "ci": "npm run check && npm test",
     "pretest": "mongodb-runner install",
-    "test": "mocha",
+    "test": "mocha --timeout 15000",
     "check": "mongodb-js-precommit"
   },
   "peerDependencies": {

test/connect.test.js

@@ -4,6 +4,7 @@ const Connection = require('../');
 const connect = Connection.connect;
 const mock = require('mock-require');
 const sinon = require('sinon');
+const SSHTunnel = require('@mongodb-js/ssh-tunnel').default;
 
 const setupListeners = () => {};
 
@@ -74,13 +75,15 @@ describe('connection model connector', () => {
     });
 
     describe('ssh tunnel failures', () => {
-      const spy = sinon.spy();
+      let closeSpy;
 
-      mock('../lib/ssh-tunnel', (model, cb) => {
-        // simulate successful tunnel creation
-        cb();
-        // then return a mocked tunnel object with a spy close() function
-        return { close: spy };
+      mock('@mongodb-js/ssh-tunnel', {
+        default: class MockTunnel extends SSHTunnel {
+          constructor(...args) {
+            super(...args);
+            this.close = closeSpy = sinon.spy(this.close.bind(this));
+          }
+        }
       });
 
       const MockConnection = mock.reRequire('../lib/extended-model');
@@ -99,12 +102,46 @@ describe('connection model connector', () => {
 
         assert(model.isValid());
         mockConnect(model, setupListeners, (err) => {
-          // must throw error here, because the connection details are invalid
-          assert.ok(err);
-          assert.ok(/ECONNREFUSED/.test(err.message));
-          // assert that tunnel.close() was called once
-          assert.ok(spy.calledOnce);
-          done();
+          try {
+            // must throw error here, because the connection details are invalid
+            assert.ok(err);
+            // assert that tunnel.close() was called once
+            assert.ok(
+              closeSpy.calledOnce,
+              'Expected tunnel.close to be called exactly once'
+            );
+            done();
+          } catch (e) {
+            done(e);
+          }
+        });
+      });
+
+      it('should propagate tunnel error if tunnel fails to connect', (done) => {
+        const model = new MockConnection({
+          hostname: 'localhost',
+          port: 27020,
+          sshTunnel: 'USER_PASSWORD',
+          sshTunnelHostname: 'my.ssh-server.com',
+          sshTunnelPassword: 'password',
+          sshTunnelUsername: 'my-user',
+          extraOptions: { serverSelectionTimeoutMS: 100 }
+        });
+
+        assert(model.isValid());
+        mockConnect(model, setupListeners, (err) => {
+          try {
+            const regex = /ENOTFOUND my.ssh-server.com/;
+
+            assert.ok(err);
+            assert.ok(
+              regex.test(err.message),
+              `Expected "${err.message}" to match ${regex}`
+            );
+            done();
+          } catch (e) {
+            done(e);
+          }
         });
       });
     });