🔨 Enable debugging

Forward ports to allow for debugging outside docker container.

Since this API (v4) is behind a proxy of previous versions of API,
there is a conflict in port numbers, so instead of default Node.js
inspect port (9229), other port number is used - 9339.

Author: Pl217

bin/port-forward.js

@@ -0,0 +1,34 @@
+#! /usr/bin/env node
+
+/*
+ * A script that forwards port 9393 to 9339 to allow for attaching a debugger
+ * from outside of the docker image.
+ */
+
+const net = require('net');
+
+net
+  .createServer((from) => {
+    try {
+      const to = net.createConnection({
+        host: 'localhost',
+        port: 9339,
+      });
+      const close = () => {
+        to.destroy();
+        from.destroy();
+      };
+      from.pipe(to);
+      to.pipe(from);
+      to.on('close', close);
+      to.on('error', close);
+      to.on('end', close);
+      from.on('close', close);
+      from.on('error', close);
+      from.on('end', close);
+    } catch (e) {
+      console.log('Unable to connect');
+      from.destroy();
+    }
+  })
+  .listen(9393);

docker-compose.integrated.yml

@@ -7,6 +7,9 @@ services:
       dockerfile: ./env/api/Dockerfile
     expose:
       - '5100'
+      - '9393'
+    ports:
+      - '9339:9393'
     volumes:
       - .:/srv/www
       - ../hpc-api-core:/srv/hpc-api-core

env/api/node.sh

@@ -7,6 +7,9 @@ if [ ! -d "node_modules" ]; then
   npm install
 fi
 
+echo "==> Starting port forwarding for debugger"
+node bin/port-forward.js &
+
 echo "==> Waiting for postgres to start"
 /wait
 

package.json

@@ -9,7 +9,7 @@
     "check-types": "tsc --noEmit",
     "install-and-link": "sh ./bin/install.sh",
     "start": "ts-node src/server.ts",
-    "dev": "ts-node-dev --transpile-only --no-notify src/server.ts",
+    "dev": "ts-node-dev --inspect=127.0.0.1:9339 --transpile-only --no-notify -- src/server.ts",
     "prepare": "husky install",
     "lint-prettier": "prettier -c .",
     "lint-eslint": "eslint --quiet .",

tsconfig.json

@@ -17,6 +17,6 @@
     "strictPropertyInitialization": false,
     "strict": true
   },
-  "include": ["src/**/*.ts"],
+  "include": ["src/**/*.ts", "bin"],
   "exclude": ["node_modules"]
 }