using SingletonInAppStateMixin for VolumesManager

Author: Andrei Neagu

services/agent/src/simcore_service_agent/api/rpc/_volumes.py

@@ -7,7 +7,7 @@
 from servicelib.rabbitmq.rpc_interfaces.agent.errors import (
     NoServiceVolumesFoundRPCError,
 )
-from simcore_service_agent.services.volumes_manager import get_volumes_manager
+from simcore_service_agent.services.volumes_manager import VolumesManager
 
 _logger = logging.getLogger(__name__)
 
@@ -19,10 +19,10 @@ async def remove_volumes_without_backup_for_service(
     app: FastAPI, *, node_id: NodeID
 ) -> None:
     with log_context(_logger, logging.INFO, f"removing volumes for service: {node_id}"):
-        await get_volumes_manager(app).remove_service_volumes(node_id)
+        await VolumesManager.get_from_app_state(app).remove_service_volumes(node_id)
 
 
 @router.expose()
 async def backup_and_remove_volumes_for_all_services(app: FastAPI) -> None:
     with log_context(_logger, logging.INFO, "removing all service volumes from node"):
-        await get_volumes_manager(app).remove_all_volumes()
+        await VolumesManager.get_from_app_state(app).remove_all_volumes()

services/agent/src/simcore_service_agent/services/volumes_manager.py

@@ -10,6 +10,7 @@
 from models_library.projects_nodes_io import NodeID
 from pydantic import NonNegativeFloat
 from servicelib.background_task import start_periodic_task, stop_periodic_task
+from servicelib.fastapi.app_state import SingletonInAppStateMixin
 from servicelib.logging_utils import log_context
 from servicelib.rabbitmq.rpc_interfaces.agent.errors import (
     NoServiceVolumesFoundRPCError,
@@ -25,7 +26,7 @@
 
 
 @dataclass
-class VolumesManager:
+class VolumesManager(SingletonInAppStateMixin):
     app: FastAPI
     book_keeping_interval: timedelta
     volume_cleanup_interval: timedelta
@@ -39,6 +40,8 @@ class VolumesManager:
 
     _task_periodic_volume_cleanup: Task | None = None
 
+    app_state_name: str = "volumes_manager"
+
     async def setup(self) -> None:
         self._task_bookkeeping = start_periodic_task(
             self._bookkeeping_task,
@@ -160,25 +163,24 @@ async def remove_all_volumes(self) -> None:
 
 
 def get_volumes_manager(app: FastAPI) -> VolumesManager:
-    volumes_manager: VolumesManager = app.state.volumes_manager
-    return volumes_manager
+    return VolumesManager.get_from_app_state(app)
 
 
 def setup_volume_manager(app: FastAPI) -> None:
     async def _on_startup() -> None:
         settings: ApplicationSettings = app.state.settings
 
-        volumes_manager = app.state.volumes_manager = VolumesManager(
+        volumes_manager = VolumesManager(
             app=app,
             book_keeping_interval=settings.AGENT_VOLUMES_CLENUP_BOOK_KEEPING_INTERVAL,
             volume_cleanup_interval=settings.AGENT_VOLUMES_CLEANUP_INTERVAL,
             remove_volumes_inactive_for=settings.AGENT_VOLUMES_CLENUP_REMOVE_VOLUMES_INACTIVE_FOR.total_seconds(),
         )
+        volumes_manager.set_to_app_state(app)
         await volumes_manager.setup()
 
     async def _on_shutdown() -> None:
-        volumes_manager: VolumesManager = app.state.volumes_manager
-        await volumes_manager.shutdown()
+        await VolumesManager.get_from_app_state(app).shutdown()
 
     app.add_event_handler("startup", _on_startup)
     app.add_event_handler("shutdown", _on_shutdown)

services/agent/tests/unit/test_services_backup.py

@@ -16,7 +16,7 @@
 from simcore_service_agent.core.settings import ApplicationSettings
 from simcore_service_agent.services.backup import backup_volume
 from simcore_service_agent.services.docker_utils import get_volume_details
-from simcore_service_agent.services.volumes_manager import get_volumes_manager
+from simcore_service_agent.services.volumes_manager import VolumesManager
 from utils import VOLUMES_TO_CREATE
 
 pytest_simcore_core_services_selection = [
@@ -60,7 +60,8 @@ async def test_backup_volume(
 
     for volume in volumes:
         volume_details = await get_volume_details(
-            get_volumes_manager(initialized_app).docker, volume_name=volume
+            VolumesManager.get_from_app_state(initialized_app).docker,
+            volume_name=volume,
         )
         # root permissions are required to access the /var/docker data
         # overwriting with a mocked path for this test

services/agent/tests/unit/test_services_docker_utils.py

@@ -21,7 +21,7 @@
     get_volume_details,
     remove_volume,
 )
-from simcore_service_agent.services.volumes_manager import get_volumes_manager
+from simcore_service_agent.services.volumes_manager import VolumesManager
 from utils import VOLUMES_TO_CREATE, get_source
 
 pytest_simcore_core_services_selection = [
@@ -52,7 +52,7 @@ def test__does_volume_require_backup(
 
 @pytest.fixture
 def volumes_manager_docker_client(initialized_app: FastAPI) -> Docker:
-    volumes_manager = get_volumes_manager(initialized_app)
+    volumes_manager = VolumesManager.get_from_app_state(initialized_app)
     return volumes_manager.docker