Debug support (#62)

* perf: include debugging support

* chore: update submodules

* perf: align start script to others

* chore: update submodules

Author: andhreljaKern

.gitignore

@@ -1,7 +1,8 @@
 *.ipynb
 .ipynb_checkpoints
 .idea
-.vscode/
+.vscode/*
+!.vscode/launch.json
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

.vscode/launch.json

@@ -0,0 +1,23 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python Debugger: refinery-weak-supervisor",
+            "type": "debugpy",
+            "request": "attach",
+            "connect": {
+                "host": "localhost",
+                "port": 15677
+            },
+            "pathMappings": [
+                {
+                    "localRoot": "${workspaceFolder}",
+                    "remoteRoot": "."
+                }
+            ]
+        }
+    ]
+}

requirements-dev.txt

@@ -1,3 +1,4 @@
 -r requirements.txt
 httpx==0.25.0
-pytest==8.1.1
+pytest==8.1.1
+debugpy==1.8.12

start

@@ -1,4 +1,20 @@
 #!/bin/bash
+
+DEBUG_MODE=false
+DEBUG_PORT=15677
+
+while getopts d flag
+do
+    case "${flag}" in
+        d) DEBUG_MODE=true;;
+    esac
+done
+
+CMD=""
+if [ $DEBUG_MODE = true ]; then
+    CMD="debugpy --wait-for-client --listen 0.0.0.0:$DEBUG_PORT -m uvicorn app:app --host 0.0.0.0 --port 80 --reload"
+fi
+
 trap "echo -ne '\nstopping container...' && docker stop refinery-weak-supervisor > /dev/null 2>&1 && echo -ne '\t\t [done]\n'" EXIT
 
 echo -ne 'stopping old container...'
@@ -20,20 +36,24 @@ then
 fi
 
 echo -ne 'building container...'
-docker build -t refinery-weak-supervisor-dev -f dev.Dockerfile . > /dev/null 2>&1
+docker build -t refinery-weak-supervisor-dev -f dev.Dockerfile .
 echo -ne '\t\t [done]\n'
 
 echo -ne 'starting...'
 docker run -d --rm \
 --name refinery-weak-supervisor \
+-p $DEBUG_PORT:$DEBUG_PORT \
 -p 7054:80 \
 -e POSTGRES=postgresql://postgres:kern@graphql-postgres:5432 \
 -e WS_NOTIFY_ENDPOINT="http://refinery-websocket:8080" \
 --mount type=bind,source="$(pwd)"/,target=/app \
 -v /var/run/docker.sock:/var/run/docker.sock \
 -v "$INFERENCE_DIR":/inference \
 --network dev-setup_default \
-refinery-weak-supervisor-dev > /dev/null 2>&1
+refinery-weak-supervisor-dev $CMD > /dev/null 2>&1
 echo -ne '\t\t\t [done]\n'
 
+if [ $DEBUG_MODE = true ]; then
+    echo -e "\033[0;33muse VSCode Debugger (Python Debugger: refinery-weak-supervisor) to start the service\033[0m"
+fi
 docker logs -f refinery-weak-supervisor