chore(ssh-tunnel): move package into monorepo COMPASS-5157 (#2670)

addaleax · web-flow · commit a06af6847bcc · 2022-01-10T15:38:09.000+01:00
Move the ssh-tunnel package from https://github.com/mongodb-js/ssh-tunnel into the monorepo. This is not a full 1:1 copy of the original: - The workspace was created with the create-workspace script - Source and test files were copied over, with two modifications: - Source files were only amended to add necessary linting overrides - Test files were amended to account for using chai instead of jest - Test fixtures were put into test/fixtures - No other files were copied - Downstream package usage was amended to fix TS compilation errors
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/connection-model/package.json b/packages/connection-model/package.json
@@ -36,7 +36,7 @@
     "mongodb": "^4.2.2"
   },
   "dependencies": {
-    "@mongodb-js/ssh-tunnel": "^1.2.1",
+    "@mongodb-js/ssh-tunnel": "^1.2.2",
     "ampersand-model": "^8.0.1",
     "ampersand-rest-collection": "^6.0.0",
     "debug": "4.3.0",
diff --git a/packages/data-service/package.json b/packages/data-service/package.json
@@ -58,7 +58,7 @@
   },
   "dependencies": {
     "@mongodb-js/compass-logging": "^0.6.0",
-    "@mongodb-js/ssh-tunnel": "^1.2.1",
+    "@mongodb-js/ssh-tunnel": "^1.2.2",
     "async": "^3.2.0",
     "debug": "4.3.0",
     "get-port": "^5.1.1",
diff --git a/packages/data-service/src/redact.ts b/packages/data-service/src/redact.ts
@@ -30,9 +30,9 @@ export function redactConnectionOptions(
   return redacted;
 }
 
-export function redactSshTunnelOptions(
-  options: SshTunnelConfig
-): SshTunnelConfig {
+export function redactSshTunnelOptions<T extends Partial<SshTunnelConfig>>(
+  options: T
+): T {
   const redacted = { ...options };
 
   if (redacted.password) {
diff --git a/packages/data-service/src/ssh-tunnel.ts b/packages/data-service/src/ssh-tunnel.ts
@@ -38,7 +38,7 @@ export async function openSshTunnel(
     forwardTimeout: 20000,
     keepaliveInterval: 20000,
     srcAddr: '127.0.0.1', // OS should figure out an ephemeral srcPort.
-    dstPort: dstPort,
+    dstPort: +dstPort,
     dstAddr: dstHost,
     localPort: localPort,
     localAddr: '127.0.0.1',
diff --git a/packages/ssh-tunnel/.depcheckrc b/packages/ssh-tunnel/.depcheckrc
@@ -0,0 +1,6 @@
+ignores:
+ - "@mongodb-js/prettier-config-compass"
+ - "@mongodb-js/tsconfig-compass"
+ - "@types/chai"
+ - "@types/sinon-chai"
+ - "sinon"
diff --git a/packages/ssh-tunnel/.eslintignore b/packages/ssh-tunnel/.eslintignore
@@ -0,0 +1,2 @@
+.nyc-output
+dist
diff --git a/packages/ssh-tunnel/.eslintrc.js b/packages/ssh-tunnel/.eslintrc.js
@@ -0,0 +1,8 @@
+module.exports = {
+  root: true,
+  extends: ['@mongodb-js/eslint-config-compass'],
+  parserOptions: {
+    tsconfigRootDir: __dirname,
+    project: ['./tsconfig-lint.json'],
+  },
+};
diff --git a/packages/ssh-tunnel/.mocharc.js b/packages/ssh-tunnel/.mocharc.js
@@ -0,0 +1 @@
+module.exports = require('@mongodb-js/mocha-config-compass');
diff --git a/packages/ssh-tunnel/.prettierignore b/packages/ssh-tunnel/.prettierignore
@@ -0,0 +1,2 @@
+.nyc-output
+dist
diff --git a/packages/ssh-tunnel/.prettierrc.json b/packages/ssh-tunnel/.prettierrc.json
@@ -0,0 +1 @@
+"@mongodb-js/prettier-config-compass"
diff --git a/packages/ssh-tunnel/package.json b/packages/ssh-tunnel/package.json
@@ -0,0 +1,72 @@
+{
+  "name": "@mongodb-js/ssh-tunnel",
+  "description": "Yet another ssh tunnel based on ssh2",
+  "author": {
+    "name": "MongoDB Inc",
+    "email": "compass@mongodb.com"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "bugs": {
+    "url": "https://jira.mongodb.org/projects/COMPASS/issues",
+    "email": "compass@mongodb.com"
+  },
+  "homepage": "https://github.com/mongodb-js/compass",
+  "version": "1.2.2",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mongodb-js/compass.git"
+  },
+  "files": [
+    "dist"
+  ],
+  "license": "Apache-2.0",
+  "main": "dist/index.js",
+  "exports": {
+    "webpack": "./src/index.ts",
+    "require": "./dist/index.js",
+    "import": "./dist/.esm-wrapper.mjs"
+  },
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "bootstrap": "npm run compile",
+    "prepublishOnly": "npm run compile",
+    "compile": "tsc -p tsconfig.json && gen-esm-wrapper . ./dist/.esm-wrapper.mjs",
+    "eslint": "eslint",
+    "prettier": "prettier",
+    "lint": "npm run eslint . && npm run prettier -- --check .",
+    "depcheck": "depcheck",
+    "check": "npm run lint && npm run depcheck",
+    "check-ci": "npm run check",
+    "test": "mocha",
+    "test-cov": "nyc -x \"**/*.spec.*\" npm run test",
+    "test-watch": "npm run test -- --watch",
+    "test-ci": "npm run test-cov",
+    "reformat": "npm run prettier -- --write ."
+  },
+  "devDependencies": {
+    "@mongodb-js/eslint-config-compass": "^0.5.0",
+    "@mongodb-js/mocha-config-compass": "^0.7.0",
+    "@mongodb-js/prettier-config-compass": "^0.4.0",
+    "@mongodb-js/tsconfig-compass": "^0.4.0",
+    "@types/chai": "^4.2.21",
+    "@types/mocha": "^9.0.0",
+    "@types/node-fetch": "^2.5.8",
+    "@types/sinon-chai": "^3.2.5",
+    "@types/ssh2": "^0.5.46",
+    "chai": "^4.3.4",
+    "depcheck": "^1.4.1",
+    "eslint": "^7.25.0",
+    "gen-esm-wrapper": "^1.1.0",
+    "mocha": "^8.4.0",
+    "node-fetch": "^2.6.1",
+    "nyc": "^15.1.0",
+    "prettier": "2.3.2",
+    "sinon": "^9.2.3",
+    "typescript": "^4.3.5"
+  },
+  "dependencies": {
+    "ssh2": "^0.8.9"
+  }
+}
diff --git a/packages/ssh-tunnel/src/index.spec.ts b/packages/ssh-tunnel/src/index.spec.ts
@@ -0,0 +1,175 @@
+import { Server as SSHServer, ServerConfig } from 'ssh2';
+import { createServer, Server as HttpServer } from 'http';
+import { promisify } from 'util';
+import { readFileSync } from 'fs';
+import path from 'path';
+import { AddressInfo, Socket } from 'net';
+import fetch from 'node-fetch';
+import { expect } from 'chai';
+
+import SSHTunnel, { SshTunnelConfig } from './index';
+
+function sleep(ms: number) {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}
+
+let sshServer: SSHServer, httpServer: HttpServer, sshTunnel: SSHTunnel;
+
+function createTestHttpServer(): Promise<void> {
+  return new Promise((resolve) => {
+    // eslint-disable-next-line @typescript-eslint/no-misused-promises
+    httpServer = createServer(async (req, res) => {
+      if (req.url === '/error') {
+        res.statusCode = 500;
+        res.end('Error');
+      } else if (req.url === '/wait') {
+        await sleep(500);
+        res.end('Waited 500ms');
+      } else {
+        res.end('Hello from http server');
+      }
+    });
+    httpServer.listen(0, 'localhost', () => {
+      resolve();
+    });
+  });
+}
+
+async function stopTestHttpServer() {
+  try {
+    await promisify(httpServer.close.bind(httpServer))();
+    (httpServer as unknown) = null;
+  } catch {
+    // noop
+  }
+}
+
+function createTestSshServer(
+  config: Partial<ServerConfig> = {}
+): Promise<void> {
+  return new Promise((resolve) => {
+    const key = path.resolve(__dirname, '..', 'test', 'fixtures', 'rsa');
+    sshServer = new SSHServer(
+      {
+        hostKeys: [readFileSync(key)],
+        ...config,
+      },
+      (client) => {
+        client
+          .on('authentication', (ctx) => {
+            ctx.accept();
+          })
+          .on('ready', () => {
+            client.on('tcpip', (accept, _reject, { destPort, destIP }) => {
+              const channel = accept();
+              const connection = new Socket();
+              channel.pipe(connection).pipe(channel);
+              connection.connect(destPort, destIP);
+            });
+          });
+      }
+    );
+    sshServer.listen(0, 'localhost', () => resolve());
+  });
+}
+
+async function stopTestSshServer() {
+  try {
+    await promisify(sshServer.close.bind(sshServer))();
+    (sshServer as unknown) = null;
+  } catch {
+    // noop
+  }
+}
+
+async function createTestSshTunnel(config: Partial<SshTunnelConfig> = {}) {
+  sshTunnel = new SSHTunnel({
+    username: 'user',
+    port: sshServer.address().port,
+    dstPort: (httpServer.address() as AddressInfo).port,
+    localPort: 0,
+    ...config,
+  });
+  await sshTunnel.listen();
+}
+
+async function stopTestSshTunnel() {
+  try {
+    await sshTunnel.close();
+    (sshTunnel as unknown) = null;
+  } catch {
+    // noop
+  }
+}
+
+function getLocalServerHost() {
+  const { localAddr, localPort } = sshTunnel.config;
+  return `http://${localAddr}:${localPort}`;
+}
+
+describe('SSHTunnel', function () {
+  beforeEach(async function () {
+    await createTestSshServer();
+    await createTestHttpServer();
+  });
+
+  afterEach(async function () {
+    await stopTestSshTunnel();
+    await stopTestSshServer();
+    await stopTestHttpServer();
+  });
+
+  it('should be main export', function () {
+    expect(new SSHTunnel()).to.be.instanceof(SSHTunnel);
+  });
+
+  it('creates a tunnel that allows to request remote server through an ssh server', async function () {
+    await createTestSshTunnel();
+
+    const res = await fetch(getLocalServerHost());
+    expect(await res.text()).to.equal('Hello from http server');
+  });
+
+  it('closes any connections on tunnel close', async function () {
+    await createTestSshTunnel();
+
+    try {
+      await Promise.all([
+        fetch(`${getLocalServerHost()}/wait`),
+        (async () => {
+          await sleep(50);
+          await sshTunnel.close();
+        })(),
+      ]);
+      expect.fail('missed exception');
+    } catch (err) {
+      expect(err.message).to.match(/socket hang up/);
+    }
+  });
+
+  it('fails on listen call if ssh server is not available', async function () {
+    try {
+      await createTestSshTunnel({
+        host: 'nonexistent-ssh-server.test',
+        port: 4242,
+      });
+      expect.fail('missed exception');
+    } catch (err) {
+      expect(err.message).to.equal(
+        'getaddrinfo ENOTFOUND nonexistent-ssh-server.test'
+      );
+    }
+  });
+
+  it('stops http server if encountered an error connecting to ssh server', async function () {
+    try {
+      await createTestSshTunnel({
+        host: 'nonexistent-ssh-server.test',
+        port: 4242,
+      });
+      expect.fail('missed exception');
+    } catch {
+      expect(sshTunnel['server'].listening).to.equal(false);
+    }
+  });
+});
diff --git a/packages/ssh-tunnel/src/index.ts b/packages/ssh-tunnel/src/index.ts
diff --git a/packages/ssh-tunnel/test/fixtures/rsa b/packages/ssh-tunnel/test/fixtures/rsa
diff --git a/packages/ssh-tunnel/test/fixtures/rsa.pub b/packages/ssh-tunnel/test/fixtures/rsa.pub
diff --git a/packages/ssh-tunnel/tsconfig-lint.json b/packages/ssh-tunnel/tsconfig-lint.json
diff --git a/packages/ssh-tunnel/tsconfig.json b/packages/ssh-tunnel/tsconfig.json

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+module.exports = require('@mongodb-js/mocha-config-compass');`