🎨 Refactor: Replace string-based app keys with type-safe web.AppKey instances in various modules

Author: pcrespov

services/web/server/src/simcore_service_webserver/diagnostics/_healthcheck.py

@@ -2,6 +2,7 @@
 import statistics
 import time
 from dataclasses import dataclass, field
+from typing import Final
 
 from aiohttp import web
 from servicelib.aiohttp.incidents import LimitedOrderedStack, SlowCallback
@@ -11,17 +12,6 @@
 
 _logger = logging.getLogger(__name__)
 
-# APP KEYS ---
-HEALTH_INCIDENTS_REGISTRY = f"{__name__}.incidents_registry"
-HEALTH_LAST_REQUESTS_AVG_LATENCY = f"{__name__}.last_requests_avg_latency"
-HEALTH_MAX_AVG_RESP_LATENCY = f"{__name__}.max_avg_response_latency"
-HEALTH_MAX_TASK_DELAY = f"{__name__}.max_task_delay"
-
-HEALTH_LATENCY_PROBE = f"{__name__}.latency_probe"
-HEALTH_PLUGIN_START_TIME = f"{__name__}.plugin_start_time"
-
-HEALTH_START_SENSING_DELAY_SECS = f"{__name__}.start_sensing_delay"
-
 
 class IncidentsRegistry(LimitedOrderedStack[SlowCallback]):
     def max_delay(self) -> float:
@@ -57,6 +47,18 @@ def value(self) -> float:
         return delay
 
 
+HEALTH_INCIDENTS_REGISTRY: Final = web.AppKey(
+    "HEALTH_INCIDENTS_REGISTRY", IncidentsRegistry
+)
+HEALTH_LATENCY_PROBE: Final = web.AppKey("HEALTH_LATENCY_PROBE", DelayWindowProbe)
+
+HEALTH_LAST_REQUESTS_AVG_LATENCY: Final = f"{__name__}.last_requests_avg_latency"
+HEALTH_MAX_AVG_RESP_LATENCY: Final = f"{__name__}.max_avg_response_latency"
+HEALTH_MAX_TASK_DELAY: Final = f"{__name__}.max_task_delay"
+HEALTH_PLUGIN_START_TIME: Final = f"{__name__}.plugin_start_time"
+HEALTH_START_SENSING_DELAY_SECS: Final = f"{__name__}.start_sensing_delay"
+
+
 _logged_once = False
 
 

services/web/server/src/simcore_service_webserver/director_v2/_director_v2_abc_service.py

@@ -3,8 +3,6 @@
 from aiohttp import web
 from models_library.projects import CommitID, ProjectID
 
-_APP_PROJECT_RUN_POLICY_KEY = f"{__name__}.ProjectRunPolicy"
-
 
 class AbstractProjectRunPolicy(ABC):
     """
@@ -42,6 +40,11 @@ async def get_or_create_runnable_projects(
     ) -> tuple[list[ProjectID], list[CommitID]]: ...
 
 
+_APP_PROJECT_RUN_POLICY_KEY = web.AppKey(
+    "_APP_PROJECT_RUN_POLICY_KEY", AbstractProjectRunPolicy
+)
+
+
 def get_project_run_policy(app: web.Application) -> AbstractProjectRunPolicy | None:
     app_: AbstractProjectRunPolicy | None = app.get(_APP_PROJECT_RUN_POLICY_KEY)
     return app_

services/web/server/src/simcore_service_webserver/fogbugz/_client.py

@@ -5,7 +5,7 @@
 
 import json
 import logging
-from typing import Any
+from typing import Any, Final
 from urllib.parse import urljoin
 
 import httpx
@@ -156,7 +156,7 @@ async def reopen_case(self, case_id: str, assigned_fogbugz_person_id: str) -> No
             raise ValueError(msg)
 
 
-_APP_KEY = f"{__name__}.{FogbugzRestClient.__name__}"
+_APP_KEY: Final = web.AppKey(FogbugzRestClient.__name__, FogbugzRestClient)
 
 
 async def setup_fogbugz_rest_client(app: web.Application) -> None:

services/web/server/src/simcore_service_webserver/garbage_collector/_tasks_utils.py

@@ -4,6 +4,7 @@
 
 import asyncio
 from collections.abc import AsyncIterator, Callable, Coroutine
+from typing import Final
 
 from aiohttp import web
 from common_library.async_tools import cancel_wait_task
@@ -19,6 +20,9 @@ def create_task_name(coro: Callable) -> str:
     return f"{coro.__module__}.{coro.__name__}"
 
 
+_GC_PERIODIC_TASKS_KEY: Final = web.AppKey("gc-tasks", dict[str, asyncio.Task])
+
+
 async def periodic_task_lifespan(
     app: web.Application,
     periodic_async_func: Callable[[], Coroutine[None, None, None]],
@@ -43,15 +47,16 @@ async def periodic_task_lifespan(
     )
 
     # Keeping a reference in app's state to prevent premature garbage collection of the task
-    app_task_key = f"gc-tasks/{task_name}"
-    if app_task_key in app:
+    app.setdefault(_GC_PERIODIC_TASKS_KEY, {})
+    if task_name in app[_GC_PERIODIC_TASKS_KEY]:
         msg = f"Task {task_name} is already registered in the app state"
         raise ValueError(msg)
 
-    app[app_task_key] = task
+    app[_GC_PERIODIC_TASKS_KEY][task_name] = task
 
     yield
 
     # tear-down
     await cancel_wait_task(task)
-    app.pop(app_task_key, None)
+    if _GC_PERIODIC_TASKS_KEY in app:
+        app[_GC_PERIODIC_TASKS_KEY].pop(task_name, None)

services/web/server/src/simcore_service_webserver/products/_web_events.py

@@ -12,7 +12,7 @@
 
 _logger = logging.getLogger(__name__)
 
-APP_PRODUCTS_TEMPLATES_DIR_KEY = f"{__name__}.template_dir"
+APP_PRODUCTS_TEMPLATES_DIR_KEY = web.AppKey("template_dir", Path)
 
 
 async def _auto_create_products_groups(app: web.Application) -> None:
@@ -59,9 +59,7 @@ async def _setup_product_templates(app: web.Application):
     """
     builds a directory and download product templates
     """
-    with tempfile.TemporaryDirectory(
-        suffix=APP_PRODUCTS_TEMPLATES_DIR_KEY
-    ) as templates_dir:
+    with tempfile.TemporaryDirectory(suffix="product_template_") as templates_dir:
         app[APP_PRODUCTS_TEMPLATES_DIR_KEY] = Path(templates_dir)
 
         yield

services/web/server/src/simcore_service_webserver/projects/_projects_repository_legacy.py

@@ -114,7 +114,6 @@
 
 _logger = logging.getLogger(__name__)
 
-APP_PROJECT_DBAPI = __name__ + ".ProjectDBAPI"
 ANY_USER = ANY_USER_ID_SENTINEL
 
 DEFAULT_ORDER_BY = OrderBy(
@@ -1392,6 +1391,9 @@ async def check_project_has_only_one_product(self, project_uuid: ProjectID) -> N
             )
 
 
+APP_PROJECT_DBAPI = web.AppKey("ProjectDBAPI", ProjectDBAPI)
+
+
 def setup_projects_db(app: web.Application):
     # NOTE: inits once per app
     return ProjectDBAPI.set_once_in_app_context(app)