♻️ Is638/dynamic sidecar refactors layout (round 4) (ITISFoundation#3156)

Author: pcrespov

services/dynamic-sidecar/openapi.json

@@ -79,6 +79,32 @@
         "summary": "Runs Docker Compose Up",
         "description": "Expects the docker-compose spec as raw-body utf-8 encoded text",
         "operationId": "runs_docker_compose_up_v1_containers_post",
+        "parameters": [
+          {
+            "description": "docker-compose up command timeout run as a background",
+            "required": false,
+            "schema": {
+              "title": "Command Timeout",
+              "type": "number",
+              "description": "docker-compose up command timeout run as a background",
+              "default": 3600.0
+            },
+            "name": "command_timeout",
+            "in": "query"
+          },
+          {
+            "description": "docker-compose config timeout (EXPERIMENTAL)",
+            "required": false,
+            "schema": {
+              "title": "Validation Timeout",
+              "type": "number",
+              "description": "docker-compose config timeout (EXPERIMENTAL)",
+              "default": 60.0
+            },
+            "name": "validation_timeout",
+            "in": "query"
+          }
+        ],
         "responses": {
           "202": {
             "description": "Successful Response",
@@ -104,12 +130,12 @@
         "operationId": "runs_docker_compose_down_v1_containers_down_post",
         "parameters": [
           {
-            "description": "docker-compose down command timeout default",
+            "description": "docker-compose down command timeout default  (EXPERIMENTAL)",
             "required": false,
             "schema": {
               "title": "Command Timeout",
               "type": "number",
-              "description": "docker-compose down command timeout default",
+              "description": "docker-compose down command timeout default  (EXPERIMENTAL)",
               "default": 10.0
             },
             "name": "command_timeout",

services/dynamic-sidecar/src/simcore_service_dynamic_sidecar/core/dependencies.py renamed to services/dynamic-sidecar/src/simcore_service_dynamic_sidecar/api/_dependencies.py

@@ -1,11 +1,15 @@
+""" Free functions to inject dependencies in routes handlers
+"""
+
+
 from fastapi import Depends, FastAPI, Request
 from fastapi.datastructures import State
 
-from ..models.domains.shared_store import SharedStore
+from ..core.rabbitmq import RabbitMQ
+from ..core.settings import DynamicSidecarSettings
 from ..models.schemas.application_health import ApplicationHealth
+from ..models.shared_store import SharedStore
 from ..modules.mounted_fs import MountedVolumes
-from .rabbitmq import RabbitMQ
-from .settings import DynamicSidecarSettings
 
 
 def get_application(request: Request) -> FastAPI:

services/dynamic-sidecar/src/simcore_service_dynamic_sidecar/api/containers.py

@@ -3,7 +3,6 @@
 import functools
 import json
 import logging
-import traceback
 from typing import Any, Union
 
 from fastapi import (
@@ -19,33 +18,29 @@
 from fastapi.responses import PlainTextResponse
 from servicelib.fastapi.requests_decorators import cancellable_request
 
-from ..core.dependencies import (
-    get_application,
-    get_application_health,
-    get_mounted_volumes,
-    get_rabbitmq,
-    get_settings,
-    get_shared_store,
-)
+from ..core.docker_compose_utils import docker_compose_down, docker_compose_up
 from ..core.docker_logs import start_log_fetching, stop_log_fetching
 from ..core.docker_utils import docker_client
 from ..core.rabbitmq import RabbitMQ
 from ..core.settings import DynamicSidecarSettings
-from ..core.shared_handlers import (
-    cleanup_containers_and_volumes,
-    remove_the_compose_spec,
-    write_file_and_run_command,
-)
 from ..core.utils import assemble_container_names
 from ..core.validation import (
     InvalidComposeSpec,
     parse_compose_spec,
     validate_compose_spec,
 )
-from ..models.domains.shared_store import SharedStore
 from ..models.schemas.application_health import ApplicationHealth
+from ..models.shared_store import SharedStore
 from ..modules.directory_watcher import directory_watcher_disabled
 from ..modules.mounted_fs import MountedVolumes
+from ._dependencies import (
+    get_application,
+    get_application_health,
+    get_mounted_volumes,
+    get_rabbitmq,
+    get_settings,
+    get_shared_store,
+)
 
 logger = logging.getLogger(__name__)
 
@@ -55,34 +50,26 @@ async def send_message(rabbitmq: RabbitMQ, message: str) -> None:
     await rabbitmq.post_log_message(f"[sidecar] {message}")
 
 
-async def _task_docker_compose_up(
+async def _task_docker_compose_up_and_send_message(
     settings: DynamicSidecarSettings,
     shared_store: SharedStore,
     app: FastAPI,
     application_health: ApplicationHealth,
     rabbitmq: RabbitMQ,
+    command_timeout: float,
 ) -> None:
     # building is a security risk hence is disabled via "--no-build" parameter
     await send_message(rabbitmq, "starting service containers")
+    assert shared_store.compose_spec  # nosec
 
     with directory_watcher_disabled(app):
-        await cleanup_containers_and_volumes(shared_store, settings)
-
-        assert shared_store.compose_spec is not None  # nosec
-
-        command = (
-            "docker-compose --project-name {project} --file {file_path} "
-            "up --no-build --detach"
-        )
-        finished_without_errors, stdout = await write_file_and_run_command(
-            settings=settings,
-            file_content=shared_store.compose_spec,
-            command=command,
-            command_timeout=None,
+        r = await docker_compose_up(
+            shared_store, settings, command_timeout=command_timeout
         )
-    message = f"Finished {command} with output\n{stdout}"
 
-    if finished_without_errors:
+    message = f"Finished docker-compose up with output\n{r.decoded_stdout}"
+
+    if r.success:
         await send_message(rabbitmq, "service containers started")
         logger.info(message)
         for container_name in shared_store.container_names:
@@ -130,6 +117,12 @@ async def runs_docker_compose_up(
     application_health: ApplicationHealth = Depends(get_application_health),
     rabbitmq: RabbitMQ = Depends(get_rabbitmq),
     mounted_volumes: MountedVolumes = Depends(get_mounted_volumes),
+    command_timeout: float = Query(
+        3600.0, description="docker-compose up command timeout run as a background"
+    ),
+    validation_timeout: float = Query(
+        60.0, description="docker-compose config timeout (EXPERIMENTAL)"
+    ),
 ) -> Union[list[str], dict[str, Any]]:
     """Expects the docker-compose spec as raw-body utf-8 encoded text"""
 
@@ -141,24 +134,28 @@ async def runs_docker_compose_up(
             settings=settings,
             compose_file_content=body_as_text,
             mounted_volumes=mounted_volumes,
+            docker_compose_config_timeout=validation_timeout,
         )
         shared_store.container_names = assemble_container_names(
             shared_store.compose_spec
         )
+
+        logger.debug("Validated compose-spec:\n%s", f"{shared_store.compose_spec}")
+
     except InvalidComposeSpec as e:
-        logger.warning("Error detected %s", traceback.format_exc())
         raise HTTPException(status.HTTP_422_UNPROCESSABLE_ENTITY, detail=f"{e}") from e
 
     # run docker-compose in a background queue and return early
     assert shared_store.compose_spec is not None  # nosec
     background_tasks.add_task(
         functools.partial(
-            _task_docker_compose_up,
+            _task_docker_compose_up_and_send_message,
             settings=settings,
             shared_store=shared_store,
             app=app,
             application_health=application_health,
             rabbitmq=rabbitmq,
+            command_timeout=command_timeout,
         )
     )
 
@@ -177,7 +174,7 @@ async def runs_docker_compose_up(
 )
 async def runs_docker_compose_down(
     command_timeout: float = Query(
-        10.0, description="docker-compose down command timeout default"
+        10.0, description="docker-compose down command timeout default  (EXPERIMENTAL)"
     ),
     settings: DynamicSidecarSettings = Depends(get_settings),
     shared_store: SharedStore = Depends(get_shared_store),
@@ -187,14 +184,13 @@ async def runs_docker_compose_down(
     and returns the docker-compose output"""
     # TODO: convert into long running operation
 
-    stored_compose_content = shared_store.compose_spec
-    if stored_compose_content is None:
+    if shared_store.compose_spec is None:
         raise HTTPException(
             status.HTTP_404_NOT_FOUND,
-            detail="No spec for docker-compose down was found",
+            detail="No compose-specs were found",
         )
 
-    finished_without_errors, stdout = await remove_the_compose_spec(
+    result = await docker_compose_down(
         shared_store=shared_store,
         settings=settings,
         command_timeout=command_timeout,
@@ -203,11 +199,16 @@ async def runs_docker_compose_down(
     for container_name in shared_store.container_names:
         await stop_log_fetching(app, container_name)
 
-    if not finished_without_errors:
-        logger.warning("docker-compose down command finished with errors\n%s", stdout)
-        raise HTTPException(status.HTTP_422_UNPROCESSABLE_ENTITY, detail=stdout)
+    if not result.success:
+        logger.warning(
+            "docker-compose down command finished with errors\n%s",
+            result.decoded_stdout,
+        )
+        raise HTTPException(
+            status.HTTP_422_UNPROCESSABLE_ENTITY, detail=result.decoded_stdout
+        )
 
-    return stdout
+    return result.decoded_stdout
 
 
 @containers_router.get(

services/dynamic-sidecar/src/simcore_service_dynamic_sidecar/api/containers_extension.py

@@ -22,23 +22,22 @@
 from servicelib.utils import logged_gather
 from simcore_sdk.node_ports_v2.port_utils import is_file_type
 
-from ..core.dependencies import (
-    get_application,
-    get_mounted_volumes,
-    get_rabbitmq,
-    get_settings,
-    get_shared_store,
-)
+from ..core.docker_compose_utils import docker_compose_restart
 from ..core.docker_logs import start_log_fetching, stop_log_fetching
 from ..core.docker_utils import docker_client
 from ..core.rabbitmq import RabbitMQ
 from ..core.settings import DynamicSidecarSettings
-from ..core.shared_handlers import write_file_and_run_command
-from ..models.domains.shared_store import SharedStore
-from ..models.schemas.ports import PortTypeName
+from ..models.shared_store import SharedStore
 from ..modules import directory_watcher, nodeports
 from ..modules.data_manager import pull_path_if_exists, upload_path_if_exists
 from ..modules.mounted_fs import MountedVolumes
+from ._dependencies import (
+    get_application,
+    get_mounted_volumes,
+    get_rabbitmq,
+    get_settings,
+    get_shared_store,
+)
 from .containers import send_message
 
 logger = logging.getLogger(__name__)
@@ -143,7 +142,9 @@ async def pull_input_ports(
 
     await send_message(rabbitmq, f"Pulling inputs for {port_keys}")
     transferred_bytes = await nodeports.download_target_ports(
-        PortTypeName.INPUTS, mounted_volumes.disk_inputs_path, port_keys=port_keys
+        nodeports.PortTypeName.INPUTS,
+        mounted_volumes.disk_inputs_path,
+        port_keys=port_keys,
     )
     await send_message(rabbitmq, "Finished pulling inputs")
     return int(transferred_bytes)
@@ -201,7 +202,9 @@ async def pull_output_ports(
 
     await send_message(rabbitmq, f"Pulling output for {port_keys}")
     transferred_bytes = await nodeports.download_target_ports(
-        PortTypeName.OUTPUTS, mounted_volumes.disk_outputs_path, port_keys=port_keys
+        nodeports.PortTypeName.OUTPUTS,
+        mounted_volumes.disk_outputs_path,
+        port_keys=port_keys,
     )
     await send_message(rabbitmq, "Finished pulling output")
     return int(transferred_bytes)
@@ -255,10 +258,10 @@ async def restarts_containers(
     rabbitmq: RabbitMQ = Depends(get_rabbitmq),
 ) -> None:
     """Removes the previously started service
-    and returns the docker-compose output"""
+    and returns the docker-compose output
+    """
 
-    stored_compose_content = shared_store.compose_spec
-    if stored_compose_content is None:
+    if shared_store.compose_spec is None:
         raise HTTPException(
             status.HTTP_404_NOT_FOUND,
             detail="No spec for docker-compose command was found",
@@ -267,21 +270,17 @@ async def restarts_containers(
     for container_name in shared_store.container_names:
         await stop_log_fetching(app, container_name)
 
-    command = (
-        "docker-compose --project-name {project} --file {file_path} "
-        "restart --timeout {stop_and_remove_timeout}"
+    result = await docker_compose_restart(
+        shared_store.compose_spec, settings, command_timeout=command_timeout
     )
 
-    finished_without_errors, stdout = await write_file_and_run_command(
-        settings=settings,
-        file_content=stored_compose_content,
-        command=command,
-        command_timeout=command_timeout,
-    )
-    if not finished_without_errors:
-        error_message = (f"'{command}' finished with errors\n{stdout}",)
-        logger.warning(error_message)
-        raise HTTPException(status.HTTP_422_UNPROCESSABLE_ENTITY, detail=stdout)
+    if not result.success:
+        logger.warning(
+            "docker-compose restart finished with errors\n%s", result.decoded_stdout
+        )
+        raise HTTPException(
+            status.HTTP_422_UNPROCESSABLE_ENTITY, detail=result.decoded_stdout
+        )
 
     for container_name in shared_store.container_names:
         await start_log_fetching(app, container_name)

services/dynamic-sidecar/src/simcore_service_dynamic_sidecar/api/health.py

@@ -1,7 +1,7 @@
 from fastapi import APIRouter, Depends, HTTPException, status
 
-from ..core.dependencies import get_application_health
 from ..models.schemas.application_health import ApplicationHealth
+from ._dependencies import get_application_health
 
 health_router = APIRouter()
 

services/dynamic-sidecar/src/simcore_service_dynamic_sidecar/core/application.py

@@ -6,17 +6,17 @@
 
 from .._meta import API_VTAG, __version__
 from ..api import main_router
-from ..models.domains.shared_store import SharedStore
 from ..models.schemas.application_health import ApplicationHealth
+from ..models.shared_store import SharedStore
 from ..modules.directory_watcher import setup_directory_watcher
 from ..modules.mounted_fs import MountedVolumes, setup_mounted_fs
+from .docker_compose_utils import docker_compose_down
 from .docker_logs import setup_background_log_fetcher
 from .error_handlers import http_error_handler, node_not_found_error_handler
 from .errors import BaseDynamicSidecarError
 from .rabbitmq import setup_rabbitmq
 from .remote_debug import setup as remote_debug_setup
 from .settings import DynamicSidecarSettings
-from .shared_handlers import remove_the_compose_spec
 from .utils import login_registry, volumes_fix_permissions
 
 logger = logging.getLogger(__name__)
@@ -101,7 +101,7 @@ async def _on_startup() -> None:
 
     async def _on_shutdown() -> None:
         logger.info("Going to remove spawned containers")
-        result = await remove_the_compose_spec(
+        result = await docker_compose_down(
             shared_store=app.state.shared_store,
             settings=app.state.settings,
             command_timeout=app.state.settings.DYNAMIC_SIDECAR_DOCKER_COMPOSE_DOWN_TIMEOUT,