refactor: simplify volume loading and DEBUG variables

Author: suricactus

.env.example

@@ -384,14 +384,8 @@ DEBUG_WORKER_WRAPPER_DEBUGPY_PORT=5679
 # DEFAULT: ""
 DEBUG_QGIS_DEBUGPY_PORT=""
 
-# Host path to `libqfieldsync` which will be mounted by the `worker_wrapper` into the `worker` containers to facilitate development and debugging of `libqfieldsync`.
-# If empty value or invalid value, the pip installed version defined in `requirements_libqfieldsync.txt` will be used.
-# The provided path must be the root of the https://github.com/opengisch/libqfieldsync repository.
+# Host path which will be mounted by the `worker_wrapper` into the `worker` containers to facilitate development and debugging pythons files.
+# Will mount `qfc_worker`, `entrypoint.py`, and if existent - `qfieldcloud-sdk` and `libqfieldsync`.
+# If empty value or invalid value, the copied by docker or pip installed versions will be used.
 # DEFAULT: ""
-DEBUG_QGIS_LIBQFIELDSYNC_HOST_PATH=""
-
-# Host path to `qfieldcloud-sdk-python` which will be mounted by the `worker_wrapper` into the `worker` containers to facilitate development and debugging of `qfieldcloud-sdk`.
-# If empty value or invalid value, the pip installed version defined in `requirements.txt` will be used.
-# The provided path must be the root of the https://github.com/opengisch/qfieldcloud-sdk-python repository.
-# DEFAULT: ""
-DEBUG_QGIS_QFIELDCLOUD_SDK_HOST_PATH=""
+DEBUG_QGIS_WORKER_HOST_PATH=""

docker-app/qfieldcloud/settings.py

@@ -723,15 +723,8 @@ def before_send(event, hint):
 # URL the qgis worker will use to access the running API endpoint on the app service
 QFIELDCLOUD_WORKER_QFIELDCLOUD_URL = os.environ["QFIELDCLOUD_WORKER_QFIELDCLOUD_URL"]
 
-# Absolute path on the docker host where `libqfieldsync` is mounted from for development
-DEBUG_QGIS_LIBQFIELDSYNC_HOST_PATH = os.environ.get(
-    "DEBUG_QGIS_LIBQFIELDSYNC_HOST_PATH"
-)
-
-# Absolute path on the docker host where `qfieldcloud-sdk-python` is mounted from for development
-DEBUG_QGIS_QFIELDCLOUD_SDK_HOST_PATH = os.environ.get(
-    "DEBUG_QGIS_QFIELDCLOUD_SDK_HOST_PATH"
-)
+# Host path which will be mounted by the `worker_wrapper` into the `worker` containers to facilitate development and debugging pythons files.
+DEBUG_QGIS_WORKER_HOST_PATH = os.environ.get("DEBUG_QGIS_WORKER_HOST_PATH")
 
 # Port to be used by `debugpy` to connect to the QGIS process inside the `qgis` container
 DEBUG_QGIS_DEBUGPY_PORT = os.environ.get("DEBUG_QGIS_DEBUGPY_PORT")

docker-app/worker_wrapper/wrapper.py

@@ -213,8 +213,6 @@ def run(self):
             self.before_docker_run()
 
             command = self.get_command()
-            volumes = []
-            volumes.append(f"{str(self.shared_tempdir)}:/io/:rw")
 
             exit_code, output = self._run_docker(command)
 
@@ -343,16 +341,19 @@ def _run_docker(self, command: list[str]) -> tuple[int, bytes]:
                     }
                 )
 
-            # used for local development of QFieldCloud
-            if settings.DEBUG_QGIS_LIBQFIELDSYNC_HOST_PATH:
-                volumes.append(
-                    f"{settings.DEBUG_QGIS_LIBQFIELDSYNC_HOST_PATH}:/libqfieldsync:ro"
-                )
-
-            # used for local development of QFieldCloud
-            if settings.DEBUG_QGIS_QFIELDCLOUD_SDK_HOST_PATH:
-                volumes.append(
-                    f"{settings.DEBUG_QGIS_QFIELDCLOUD_SDK_HOST_PATH}:/qfieldcloud-sdk-python:ro"
+            if settings.DEBUG_QGIS_WORKER_HOST_PATH:
+                debug_host_path = Path(settings.DEBUG_QGIS_WORKER_HOST_PATH)
+
+                volumes.extend(
+                    [
+                        # allow local development for `docker-qgis`
+                        f"{debug_host_path.joinpath('qfc_worker')}:/usr/src/app/qfc_worker:ro",
+                        f"{debug_host_path.joinpath('entrypoint.py')}:/usr/src/app/entrypoint.py:ro",
+                        # allow local development for `libqfieldsync` if host directory present; requires `PYTHONPATH=/libqfieldsync:${PYTHONPATH}`
+                        f"{debug_host_path.joinpath('libqfieldsync')}:/libqfieldsync.py:ro",
+                        # allow local development for `qfieldcloud-sdk-python` if host directory present; requires `PYTHONPATH=/qfieldcloud-sdk-python:${PYTHONPATH}`"
+                        f"{debug_host_path.joinpath('qfieldcloud-sdk-python')}:/qfieldcloud-sdk-python.py:ro",
+                    ]
                 )
 
         logger.info(f"Execute: {' '.join(command)}")

docker-compose.override.local.yml

@@ -35,9 +35,8 @@ services:
     ports:
       - ${DEBUG_WORKER_WRAPPER_DEBUGPY_PORT:-5679}:5679
     environment:
-      DEBUG_QGIS_LIBQFIELDSYNC_HOST_PATH: ${DEBUG_QGIS_LIBQFIELDSYNC_HOST_PATH}
-      DEBUG_QGIS_QFIELDCLOUD_SDK_HOST_PATH: ${DEBUG_QGIS_QFIELDCLOUD_SDK_HOST_PATH}
       DEBUG_QGIS_DEBUGPY_PORT: ${DEBUG_QGIS_DEBUGPY_PORT}
+      DEBUG_QGIS_WORKER_HOST_PATH: ${DEBUG_QGIS_WORKER_HOST_PATH:-}
     volumes:
       # mount the source for live reload
       - ./docker-app/qfieldcloud:/usr/src/app/qfieldcloud

scripts/check_envvars.sh

@@ -1,3 +1,3 @@
 #!/bin/bash -e
 
-python3 scripts/check_envvars.py .env.example --docker-compose-dir . --ignored-varnames DEBUG_APP_DEBUGPY_PORT DEBUG_WORKER_WRAPPER_DEBUGPY_PORT DEBUG_QGIS_DEBUGPY_PORT
+python3 scripts/check_envvars.py .env.example --docker-compose-dir . --ignored-varnames DEBUG_APP_DEBUGPY_PORT DEBUG_WORKER_WRAPPER_DEBUGPY_PORT DEBUG_QGIS_DEBUGPY_PORT DEBUG_QGIS_WORKER_HOST_PATH