🐛 Reverting ITISFoundation#3239 code and fixing it (ITISFoundation#3302)

Co-authored-by: Andrei Neagu <[email protected]>

Author: GitHK

packages/models-library/src/models_library/services.py

@@ -7,6 +7,7 @@
 from datetime import datetime
 from enum import Enum
 from typing import Any, Optional, Union
+from uuid import UUID
 
 from pydantic import (
     BaseModel,
@@ -60,6 +61,8 @@
 ServiceKey = constr(regex=KEY_RE)
 ServiceVersion = constr(regex=VERSION_RE)
 
+RunID = UUID
+
 
 class ServiceType(str, Enum):
     COMPUTATIONAL = "computational"

packages/service-library/src/servicelib/docker_utils.py

@@ -0,0 +1,14 @@
+from datetime import datetime
+
+DOCKER_TIMESTAMP_LENGTH = len("2020-10-09T12:28:14.771034")
+
+
+def to_datetime(docker_timestamp: str) -> datetime:
+    # datetime_str is typically '2020-10-09T12:28:14.771034099Z'
+    #  - The T separates the date portion from the time-of-day portion
+    #  - The Z on the end means UTC, that is, an offset-from-UTC
+    # The 099 before the Z is not clear, therefore we will truncate the last part
+    # NOTE: must be in UNIX Timestamp format
+    return datetime.strptime(
+        docker_timestamp[:DOCKER_TIMESTAMP_LENGTH], "%Y-%m-%dT%H:%M:%S.%f"
+    )

packages/service-library/tests/test_docker_utils.py

@@ -0,0 +1,12 @@
+from datetime import datetime
+
+import pytest
+from servicelib.docker_utils import to_datetime
+
+
+@pytest.mark.parametrize(
+    "docker_time, expected_datetime",
+    [("2020-10-09T12:28:14.771034099Z", datetime(2020, 10, 9, 12, 28, 14, 771034))],
+)
+def test_to_datetime(docker_time: str, expected_datetime: datetime):
+    assert to_datetime(docker_time) == expected_datetime

services/dask-sidecar/src/simcore_service_dask_sidecar/computational_sidecar/docker_utils.py

@@ -4,7 +4,6 @@
 import re
 import socket
 from contextlib import asynccontextmanager
-from datetime import datetime
 from pathlib import Path
 from pprint import pformat
 from typing import (
@@ -14,8 +13,11 @@
     Awaitable,
     Callable,
     Coroutine,
+    Dict,
     Final,
+    List,
     Optional,
+    Tuple,
     cast,
 )
 
@@ -29,6 +31,7 @@
 from packaging import version
 from pydantic import ByteSize
 from pydantic.networks import AnyUrl
+from servicelib.docker_utils import to_datetime
 from settings_library.s3 import S3Settings
 
 from ..boot_mode import BootMode
@@ -50,10 +53,10 @@ async def create_container_config(
     docker_registry: str,
     service_key: str,
     service_version: str,
-    command: list[str],
+    command: List[str],
     comp_volume_mount_point: str,
     boot_mode: BootMode,
-    task_max_resources: dict[str, Any],
+    task_max_resources: Dict[str, Any],
 ) -> DockerContainerConfig:
 
     nano_cpus_limit = int(task_max_resources.get("CPU", 1) * 1e9)
@@ -121,20 +124,6 @@ async def managed_container(
             raise
 
 
-DOCKER_TIMESTAMP_LENGTH = len("2020-10-09T12:28:14.771034")
-
-
-def to_datetime(docker_timestamp: str) -> datetime:
-    # datetime_str is typically '2020-10-09T12:28:14.771034099Z'
-    #  - The T separates the date portion from the time-of-day portion
-    #  - The Z on the end means UTC, that is, an offset-from-UTC
-    # The 099 before the Z is not clear, therefore we will truncate the last part
-    # NOTE: must be in UNIX Timestamp format
-    return datetime.strptime(
-        docker_timestamp[:DOCKER_TIMESTAMP_LENGTH], "%Y-%m-%dT%H:%M:%S.%f"
-    )
-
-
 DOCKER_LOG_REGEXP = re.compile(
     r"^([0-9]+-[0-9]+-[0-9]+T[0-9]+:[0-9]+:[0-9]+.[0-9]+.) (.+)$"
 )
@@ -144,7 +133,7 @@ def to_datetime(docker_timestamp: str) -> datetime:
 DEFAULT_TIME_STAMP = "2000-01-01T00:00:00.000000000Z"
 
 
-async def parse_line(line: str) -> tuple[LogType, str, str]:
+async def parse_line(line: str) -> Tuple[LogType, str, str]:
     match = re.search(DOCKER_LOG_REGEXP, line)
     if not match:
         # default return as log

services/dask-sidecar/tests/unit/test_docker_utils.py

@@ -4,8 +4,7 @@
 # pylint: disable=no-member
 
 import asyncio
-from datetime import datetime
-from typing import Any
+from typing import Any, Dict, List, Tuple
 from unittest.mock import call
 
 import aiodocker
@@ -18,7 +17,6 @@
     create_container_config,
     managed_container,
     parse_line,
-    to_datetime,
 )
 
 
@@ -38,7 +36,7 @@ def service_version() -> str:
 
 
 @pytest.fixture()
-def command() -> list[str]:
+def command() -> List[str]:
     return ["sh", "-c", "some_app"]
 
 
@@ -55,10 +53,10 @@ async def test_create_container_config(
     docker_registry: str,
     service_key: str,
     service_version: str,
-    command: list[str],
+    command: List[str],
     comp_volume_mount_point: str,
     boot_mode: BootMode,
-    task_max_resources: dict[str, Any],
+    task_max_resources: Dict[str, Any],
 ):
 
     container_config = await create_container_config(
@@ -97,14 +95,6 @@ async def test_create_container_config(
     )
 
 
-@pytest.mark.parametrize(
-    "docker_time, expected_datetime",
-    [("2020-10-09T12:28:14.771034099Z", datetime(2020, 10, 9, 12, 28, 14, 771034))],
-)
-def test_to_datetime(docker_time: str, expected_datetime: datetime):
-    assert to_datetime(docker_time) == expected_datetime
-
-
 @pytest.mark.parametrize(
     "log_line, expected_parsing",
     [
@@ -198,7 +188,7 @@ def test_to_datetime(docker_time: str, expected_datetime: datetime):
         ),
     ],
 )
-async def test_parse_line(log_line: str, expected_parsing: tuple[LogType, str, str]):
+async def test_parse_line(log_line: str, expected_parsing: Tuple[LogType, str, str]):
     assert await parse_line(log_line) == expected_parsing
 
 
@@ -214,7 +204,7 @@ async def test_managed_container_always_removes_container(
     docker_registry: str,
     service_key: str,
     service_version: str,
-    command: list[str],
+    command: List[str],
     comp_volume_mount_point: str,
     mocker: MockerFixture,
     exception_type: Exception,

services/director-v2/src/simcore_service_director_v2/cli.py

@@ -23,9 +23,7 @@
 from .modules.db.repositories.projects import ProjectsRepository
 from .modules.director_v0 import DirectorV0Client
 from .modules.dynamic_sidecar import api_client
-from .modules.dynamic_sidecar.scheduler.events_utils import (
-    fetch_repo_outside_of_request,
-)
+from .modules.dynamic_sidecar.scheduler._utils import fetch_repo_outside_of_request
 from .modules.projects_networks import requires_dynamic_sidecar
 
 DEFAULT_NODE_SAVE_RETRY: Final[int] = 3

services/director-v2/src/simcore_service_director_v2/core/settings.py

@@ -361,6 +361,14 @@ class DynamicServicesSchedulerSettings(BaseCustomSettings):
         5.0, description="interval at which the scheduler cycle is repeated"
     )
 
+    DIRECTOR_V2_DYNAMIC_SCHEDULER_PENDING_VOLUME_REMOVAL_INTERVAL_S: PositiveFloat = (
+        Field(
+            30 * MINS,
+            description="interval at which cleaning of unused dy-sidecar "
+            "docker volume removal services is executed",
+        )
+    )
+
 
 class DynamicServicesSettings(BaseCustomSettings):
     # TODO: PC->ANE: refactor dynamic-sidecar settings. One settings per app module

services/director-v2/src/simcore_service_director_v2/models/schemas/constants.py

@@ -1,11 +1,15 @@
+from typing import Final
+
 # dynamic services
 
-DYNAMIC_SIDECAR_SERVICE_PREFIX = "dy-sidecar"
-DYNAMIC_PROXY_SERVICE_PREFIX = "dy-proxy"
+DYNAMIC_SIDECAR_SERVICE_PREFIX: Final[str] = "dy-sidecar"
+DYNAMIC_PROXY_SERVICE_PREFIX: Final[str] = "dy-proxy"
+DYNAMIC_VOLUME_REMOVER_PREFIX: Final[str] = "dy-volrm"
+DY_SIDECAR_NAMED_VOLUME_PREFIX: Final[str] = "dyv"
 
 # label storing scheduler_data to allow service
 # monitoring recovery after director-v2 reboots
-DYNAMIC_SIDECAR_SCHEDULER_DATA_LABEL = "io.simcore.scheduler-data"
+DYNAMIC_SIDECAR_SCHEDULER_DATA_LABEL: Final[str] = "io.simcore.scheduler-data"
 
 # This matches registries by:
 # - local

services/director-v2/src/simcore_service_director_v2/models/schemas/dynamic_services/scheduler.py

@@ -10,6 +10,7 @@
     PathMappingsLabel,
     SimcoreServiceLabels,
 )
+from models_library.services import RunID
 from models_library.services_resources import ServiceResourcesDict
 from pydantic import (
     AnyHttpUrl,
@@ -142,7 +143,7 @@ def mark_removed(self) -> None:
 
 
 class DynamicSidecar(BaseModel):
-    run_id: UUID = Field(
+    run_id: RunID = Field(
         default_factory=uuid4,
         description=(
             "Used to discriminate between dynamic-sidecar docker resources "

services/director-v2/src/simcore_service_director_v2/modules/dynamic_sidecar/docker_api/__init__.py

@@ -0,0 +1,45 @@
+from ._core import (
+    are_all_services_present,
+    constrain_service_to_node,
+    create_network,
+    create_service_and_get_id,
+    get_dynamic_sidecar_state,
+    get_dynamic_sidecars_to_observe,
+    get_or_create_networks_ids,
+    get_projects_networks_containers,
+    get_service_placement,
+    get_swarm_network,
+    inspect_service,
+    is_dynamic_service_running,
+    is_dynamic_sidecar_stack_missing,
+    list_dynamic_sidecar_services,
+    remove_dynamic_sidecar_network,
+    remove_dynamic_sidecar_stack,
+    try_to_remove_network,
+    update_scheduler_data_label,
+)
+from ._volume import remove_pending_volume_removal_services, remove_volumes_from_node
+
+__all__: tuple[str, ...] = (
+    "are_all_services_present",
+    "constrain_service_to_node",
+    "create_network",
+    "create_service_and_get_id",
+    "get_dynamic_sidecar_state",
+    "get_dynamic_sidecars_to_observe",
+    "get_or_create_networks_ids",
+    "get_projects_networks_containers",
+    "get_service_placement",
+    "get_swarm_network",
+    "inspect_service",
+    "is_dynamic_service_running",
+    "is_dynamic_sidecar_stack_missing",
+    "list_dynamic_sidecar_services",
+    "remove_dynamic_sidecar_network",
+    "remove_dynamic_sidecar_stack",
+    "remove_pending_volume_removal_services",
+    "remove_volumes_from_node",
+    "try_to_remove_network",
+    "update_scheduler_data_label",
+)
+# nopycln: file