Add debugger support for fastapi

Author: cdrini

.vscode/launch.json

@@ -5,7 +5,7 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "name": "Python: Attach",
+      "name": "OL: Attach to Web Container",
       "type": "debugpy",
       "request": "attach",
       "connect": {
@@ -18,6 +18,21 @@
           "remoteRoot": "/openlibrary/"
         }
       ]
+    },
+    {
+      "name": "OL: Attach to FastAPI Container",
+      "type": "debugpy",
+      "request": "attach",
+      "connect": {
+        "host": "localhost",
+        "port": 3001
+      },
+      "pathMappings": [
+        {
+          "localRoot": "${workspaceFolder}",
+          "remoteRoot": "/openlibrary/"
+        }
+      ]
     }
   ]
 }

compose.override.yaml

@@ -30,6 +30,9 @@ services:
     build:
       context: .
       dockerfile: docker/Dockerfile.oldev
+    ports:
+      # Debugger
+      - 3001:3000
     volumes:
       - .:/openlibrary
     environment:

compose.yaml

@@ -20,7 +20,7 @@ services:
     image: "${OLIMAGE:-oldev:latest}"
     environment:
       - OL_CONFIG=${OL_CONFIG:-/openlibrary/conf/openlibrary.yml}
-      - GUNICORN_OPTS=${GUNICORN_OPTS:- --reload --workers 2 --timeout 180 --max-requests 500}
+      - GUNICORN_OPTS=${GUNICORN_OPTS:- --reload --workers 1 --timeout 180 --max-requests 500}
     command: docker/ol-web-fastapi-start.sh
     ports:
       - ${FAST_WEB_PORT:-18080}:8080

openlibrary/asgi_app.py

@@ -178,18 +178,20 @@ async def set_context(request: Request, call_next):
     def health() -> dict[str, str]:
         return {"status": "ok"}
 
-    from openlibrary.fastapi.account import router as account_router  # type: ignore
-    from openlibrary.fastapi.languages import router as languages_router  # type: ignore
-    from openlibrary.fastapi.publishers import router as publishers_router  # type: ignore
-    from openlibrary.fastapi.search import router as search_router  # type: ignore
-    from openlibrary.fastapi.subjects import router as subjects_router  # type: ignore
+    from openlibrary.fastapi.account import router as account_router
+    from openlibrary.fastapi.dev import router as dev_router
+    from openlibrary.fastapi.languages import router as languages_router
+    from openlibrary.fastapi.publishers import router as publishers_router
+    from openlibrary.fastapi.search import router as search_router
+    from openlibrary.fastapi.subjects import router as subjects_router
 
     # Include routers
     app.include_router(languages_router)
     app.include_router(publishers_router)
     app.include_router(search_router)
     app.include_router(subjects_router)
     app.include_router(account_router)
+    app.include_router(dev_router)
 
     return app
 

openlibrary/fastapi/dev.py

@@ -0,0 +1,19 @@
+import os
+
+import debugpy  # noqa: T100
+from fastapi import APIRouter
+
+router = APIRouter()
+
+
+@router.get("/admin/attach_debugger")
+async def attach_debugger():
+    """
+    Attach the debugger to the running container.
+    """
+    if os.environ.get('LOCAL_DEV') != 'true':
+        return {"status": "Debugger attachment is only allowed in LOCAL_DEV mode."}
+
+    debugpy.listen(('0.0.0.0', 3000))  # noqa: T100
+    debugpy.wait_for_client()  # noqa: T100
+    return {"status": "Debugger attached."}