[server] allow debugging (#17911)

Author: svenefftinge

.vscode/launch.json

@@ -1,5 +1,18 @@
 {
     "configurations": [
+        {
+            "name": "Attach to Kubernetes Node",
+            "type": "node",
+            "request": "attach",
+            "smartStep": true,
+            "port": 9229,
+            "address": "127.0.0.1",
+            "localRoot": "${workspaceFolder}/components",
+            "remoteRoot": "/app/node_modules/@gitpod",
+            "skipFiles": [
+                "<node_internals>/**"
+            ]
+        },
         {
             "name": "Attach to Node",
             "type": "node",
@@ -21,19 +34,18 @@
             "mode": "remote"
         },
         {
-            // This will run the db-test yarn target in the gitpod-db component.
-            // This allows you to set breakpoints in your tests and step through
-            // them with the VSCode debugger.
             "type": "node",
             "request": "launch",
             "name": "gitpod-db-tests",
             "cwd": "${workspaceFolder}/components/gitpod-db",
             "runtimeExecutable": "yarn",
-            "runtimeArgs": ["db-test"],
+            "runtimeArgs": [
+                "db-test"
+            ],
             "internalConsoleOptions": "openOnSessionStart",
             "skipFiles": [
                 "<node_internals>/**"
             ]
         }
     ]
-}
+}

components/server/debug.sh

@@ -1,4 +1,27 @@
 #!/bin/bash
 
-set -Eeuo pipefail
-source /workspace/gitpod/scripts/ws-deploy.sh deployment server
+deploymentName="server"
+debugPort="9229"
+
+echo "Storing the original deployment configuration in a file"
+kubectl get deployment $deploymentName -o json > original_deployment_$deploymentName.json
+
+function restore {
+  echo "Restoring the original deployment configuration and stop port forwarding"
+  kubectl replace --force -f original_deployment_$deploymentName.json
+  rm original_deployment_$deploymentName.json
+}
+trap restore EXIT
+
+echo "Add the inspect flag and debug port to the configuration"
+jq '.spec.template.spec.containers[0].command = ["yarn", "start-inspect"]' original_deployment_$deploymentName.json > new_deployment_$deploymentName.json
+
+echo "Apply the new configuration"
+kubectl apply -f new_deployment_$deploymentName.json
+rm new_deployment_$deploymentName.json
+
+echo "Scale down to one pod"
+kubectl scale deployment $deploymentName --replicas=1
+
+echo "Forward the port $debugPort to localhost. Waiting for a debugger to attach ..."
+kubectl port-forward deployment/$deploymentName $debugPort

components/server/deploy.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+set -Eeuo pipefail
+source /workspace/gitpod/scripts/ws-deploy.sh deployment server

components/server/package.json

@@ -5,7 +5,7 @@
   "license": "AGPL-3.0",
   "scripts": {
     "start": "node ./dist/main.js",
-    "start-inspect": "node --inspect=9229 ./dist/main.js",
+    "start-inspect": "node --inspect=0.0.0.0:9229 ./dist/main.js",
     "prepare": "yarn clean && yarn build",
     "build": "yarn lint && npx tsc",
     "build:clean": "yarn clean && yarn build",
@@ -22,7 +22,8 @@
     "telepresence": "telepresence --swap-deployment server --method inject-tcp --run yarn start-inspect"
   },
   "files": [
-    "/dist"
+    "/dist",
+    "/src"
   ],
   "dependencies": {
     "@authzed/authzed-node": "^0.10.0",