Feat: allows the MySQL module to connect through an SSH connection

README.md

@@ -31,10 +31,10 @@ Exemple scenario:
     npm install @fabernovel/heart-lighthouse @fabernovel/heart-slack @fabernovel/heart-mysql
     ```
 
-2. Set the credentials for Slack (API key) and MySQL (database URL)
+2. Set the credentials for Slack (Access token) and MySQL (database URL)
 
     ```bash
-    echo HEART_SLACK_API_TOKEN=xoxb-rest-of-token >> .env
+    echo HEART_SLACK_ACCESS_TOKEN=xoxb-rest-of-token >> .env
     echo HEART_MYSQL_DATABASE_URL=login:[email protected]:3306 >> .env
     ```
 
@@ -64,7 +64,7 @@ With the example scenario given previously, the Docker image is used as follow:
 
 ```shell
 docker run --rm\
-    --env HEART_SLACK_API_TOKEN=xoxb-rest-of-token\
+    --env HEART_SLACK_ACCESS_TOKEN=xoxb-rest-of-token\
     --env HEART_MYSQL_DATABASE_URL=login:[email protected]:3306\
     fabernovel/heart:latest\
     lighthouse --config '{"url":"https://heart.fabernovel.com"}' --only-listeners=mysql,slack
@@ -81,8 +81,8 @@ With the example scenario given previously, the GitHub Action is used as follow:
   with:
     analysis_service: lighthouse
     listener_services_only: mysql,slack
-    mysql_database_url: login:[email protected]:3306
-    slack_api_token: ${{ secrets.SLACK_API_TOKEN }}
+    mysql_database_url: ${{ secrets.HEART_MYSQL_DATABASE_URL }}
+    slack_access_token: ${{ secrets.HEART_SLACK_ACCESS_TOKEN }}
 ```
 
 # Design

modules/mysql/.env.schema.json

@@ -2,11 +2,13 @@
   "type": "object",
   "required": ["HEART_MYSQL_DATABASE_URL"],
   "properties": {
-    "HEART_MYSQL_DATABASE_URL": { "type": "string", "format": "uri" }
+    "HEART_MYSQL_DATABASE_URL": { "type": "string", "format": "uri" },
+    "HEART_MYSQL_SERVER_URL": { "type": "string", "format": "uri" }
   },
   "errorMessage": {
     "properties": {
-      "HEART_MYSQL_DATABASE_URL": "HEART_MYSQL_DATABASE_URL is required and must be a URL"
+      "HEART_MYSQL_DATABASE_URL": "HEART_MYSQL_DATABASE_URL is required and must be a URL",
+      "HEART_MYSQL_SERVER_URL": "HEART_MYSQL_SERVER_URL must be a URL"
     }
   }
 }

modules/mysql/package.json

@@ -36,13 +36,15 @@
     "@fabernovel/heart-common": "workspace:^4.0.0-alpha.9",
     "@mikro-orm/core": "^5.7.14",
     "@mikro-orm/migrations": "^5.7.14",
-    "@mikro-orm/mysql": "^5.7.14"
+    "@mikro-orm/mysql": "^5.7.14",
+    "ssh2": "^1.14.0"
   },
   "devDependencies": {
     "@jest/globals": "^29.6.2",
     "@mikro-orm/cli": "^5.7.14",
     "@types/jest": "^29.5.3",
     "@types/node": "^18.16.19",
+    "@types/ssh2": "^1.11.13",
     "@typescript-eslint/eslint-plugin": "^6.2.1",
     "@typescript-eslint/parser": "^6.2.1",
     "eslint": "^8.46.0",

modules/mysql/src/MySQLModule.ts

@@ -6,7 +6,7 @@ import {
   type ModuleMetadata,
   logger,
 } from "@fabernovel/heart-common"
-import { MySQLClient } from "./client/Client.js"
+import { MySQLClient } from "./client/MySQLClient.js"
 
 export class MySQLModule extends Module implements ModuleListenerDatabaseInterface {
   #client: MySQLClient

modules/mysql/src/client/SshClient.ts

@@ -0,0 +1,48 @@
+import { env } from "node:process"
+import { Client } from "ssh2"
+import databaseConfig from "../config/mikro-orm.config.js"
+
+export class SshClient {
+  #client = new Client()
+  #databaseUrl = new URL(databaseConfig.clientUrl ?? "")
+  #serverUrl = new URL(env.HEART_MYSQL_DATABASE_URL ? `ssh://${env.HEART_MYSQL_DATABASE_URL}` : "")
+
+  constructor() {
+    this.#client
+      .on("ready", () => {
+        console.log("Client :: ready")
+        this.#client.forwardIn(this.#databaseUrl.host, Number(this.#databaseUrl.port), (err) => {
+          if (err) throw err
+          console.log("Listening for this.#clientections on server on port 8000!")
+        })
+      })
+      .on("tcp connection", (info, accept) => {
+        console.log("TCP :: INCOMING CONNECTION:")
+        console.dir(info)
+        accept()
+          .on("close", () => {
+            console.log("TCP :: CLOSED")
+          })
+          .on("data", (data) => {
+            console.log("TCP :: DATA: " + data)
+          })
+          .end(
+            [
+              "HTTP/1.1 404 Not Found",
+              "Date: Thu, 15 Nov 2012 02:07:58 GMT",
+              "Server: ForwardedConnection",
+              "Content-Length: 0",
+              "Connection: close",
+              "",
+              "",
+            ].join("\r\n")
+          )
+      })
+      .connect({
+        host: this.#serverUrl.host,
+        port: Number(this.#serverUrl.port),
+        username: this.#serverUrl.username,
+        password: this.#serverUrl.password,
+      })
+  }
+}