🎨 Refactor: Introduce Final app keys for various components in the web server

Author: pcrespov

packages/service-library/src/servicelib/aiohttp/aiopg_utils.py

@@ -1,20 +1,21 @@
-""" Holderplace for random helpers using aiopg
+"""Holderplace for random helpers using aiopg
 
-    - Drop here functions/constants that at that time does
-    not fit in any of the setups. Then, they can be moved and
-    refactor when new abstractions are used in place.
+- Drop here functions/constants that at that time does
+not fit in any of the setups. Then, they can be moved and
+refactor when new abstractions are used in place.
 
-    - aiopg is used as a client sdk to interact asynchronously with postgres service
+- aiopg is used as a client sdk to interact asynchronously with postgres service
 
-    SEE for aiopg: https://aiopg.readthedocs.io/en/stable/sa.html
-    SEE for underlying psycopg: http://initd.org/psycopg/docs/module.html
-    SEE for extra keywords: https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-PARAMKEYWORDS
+SEE for aiopg: https://aiopg.readthedocs.io/en/stable/sa.html
+SEE for underlying psycopg: http://initd.org/psycopg/docs/module.html
+SEE for extra keywords: https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-PARAMKEYWORDS
 """
 
 # TODO: Towards implementing https://github.com/ITISFoundation/osparc-simcore/issues/1195
 # TODO: deprecate this module. Move utils into retry_policies, simcore_postgres_database.utils_aiopg
 
 import logging
+from typing import Final
 
 import sqlalchemy as sa
 from aiohttp import web
@@ -31,6 +32,8 @@
 
 log = logging.getLogger(__name__)
 
+APP_AIOPG_ENGINE_KEY: Final = web.AppKey("APP_AIOPG_ENGINE_KEY", Engine)
+
 
 async def raise_if_not_responsive(engine: Engine):
     async with engine.acquire() as conn:

packages/service-library/src/servicelib/aiohttp/application_keys.py

@@ -1,4 +1,4 @@
-""" Namespace to keep all application storage keys
+"""Namespace to keep all application storage keys
 
 Unique keys to identify stored data
 Naming convention accounts for the storage scope: application, request, response, configuration and/or resources
@@ -8,18 +8,21 @@
 
  See https://aiohttp.readthedocs.io/en/stable/web_advanced.html#data-sharing-aka-no-singletons-please
 """
+
 from typing import Final
 
-# REQUIREMENTS:
-# - guarantees all keys are unique
-# - one place for all common keys
-# - hierarchical classification
+from aiohttp import web
+
+# APPLICATION's CONTEXT KEYS
+
+# NOTE: use these keys to store/retrieve data from aiohttp.web.Application
+# SEE https://docs.aiohttp.org/en/stable/web_quickstart.html#aiohttp-web-app-key
 
 #
 # web.Application keys, i.e. app[APP_*_KEY]
 #
-APP_CONFIG_KEY: Final[str] = f"{__name__ }.config"
-APP_SETTINGS_KEY: Final[str] = f"{__name__ }.settings"
+APP_CONFIG_KEY = web.AppKey("APP_CONFIG_KEY", dict[str, object])
+APP_SETTINGS_KEY = web.AppKey("APP_SETTINGS_KEY", object)
 
 APP_AIOPG_ENGINE_KEY: Final[str] = f"{__name__ }.aiopg_engine"
 

packages/service-library/src/servicelib/aiohttp/client_session.py

@@ -9,7 +9,8 @@
     get_http_client_request_aiohttp_sock_connect_timeout,
     get_http_client_request_total_timeout,
 )
-from .application_keys import APP_CLIENT_SESSION_KEY
+
+APP_CLIENT_SESSION_KEY: web.AppKey[ClientSession] = web.AppKey("APP_CLIENT_SESSION_KEY")
 
 
 async def persistent_client_session(app: web.Application) -> AsyncGenerator[None, None]:

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

@@ -1,6 +1,9 @@
 import logging
+from typing import Final
 
+import aiodocker
 import aiohttp
+from aiohttp import web
 from models_library.docker import DockerGenericTag
 from pydantic import TypeAdapter, ValidationError
 from settings_library.docker_registry import RegistrySettings
@@ -18,6 +21,8 @@
 
 _logger = logging.getLogger(__name__)
 
+APP_DOCKER_ENGINE_KEY: Final = web.AppKey("APP_DOCKER_ENGINE_KEY", aiodocker.Docker)
+
 
 async def retrieve_image_layer_information(
     image: DockerGenericTag, registry_settings: RegistrySettings

packages/service-library/src/servicelib/aiohttp/long_running_tasks/server.py

@@ -6,9 +6,17 @@
 running task.
 """
 
+from typing import Final
+
+from aiohttp import web
+
 from ._manager import get_long_running_manager
 from ._server import setup, start_long_running_task
 
+APP_LONG_RUNNING_TASKS_KEY: Final = web.AppKey(
+    "APP_LONG_RUNNING_TASKS_KEY", dict[str, object]
+)
+
 __all__: tuple[str, ...] = (
     "get_long_running_manager",
     "setup",

packages/service-library/src/servicelib/aiohttp/monitor_slow_callbacks.py

@@ -1,11 +1,17 @@
 import asyncio.events
 import sys
 import time
+from typing import Final
 
+from aiohttp import web
 from pyinstrument import Profiler
 
 from .incidents import LimitedOrderedStack, SlowCallback
 
+APP_SLOW_CALLBACKS_MONITOR_KEY: Final = web.AppKey(
+    "APP_SLOW_CALLBACKS_MONITOR_KEY", LimitedOrderedStack[SlowCallback]
+)
+
 
 def enable(
     slow_duration_secs: float, incidents: LimitedOrderedStack[SlowCallback]

packages/service-library/src/servicelib/aiohttp/monitoring.py

@@ -28,6 +28,7 @@
 _logger = logging.getLogger(__name__)
 
 _PROMETHEUS_METRICS: Final[str] = f"{__name__}.prometheus_metrics"  # noqa: N816
+APP_MONITORING_NAMESPACE_KEY: Final = web.AppKey("APP_MONITORING_NAMESPACE_KEY", str)
 
 
 def get_collector_registry(app: web.Application) -> CollectorRegistry:

packages/service-library/src/servicelib/aiohttp/observer.py

@@ -6,6 +6,7 @@
 import logging
 from collections import defaultdict
 from collections.abc import Callable
+from typing import Final
 
 from aiohttp import web
 
@@ -16,6 +17,9 @@
 
 
 _APP_OBSERVER_EVENTS_REGISTRY_KEY = "{__name__}.event_registry"
+APP_FIRE_AND_FORGET_TASKS_KEY: Final = web.AppKey(
+    "APP_FIRE_AND_FORGET_TASKS_KEY", set[object]
+)
 
 
 class ObserverRegistryNotFoundError(RuntimeError): ...

packages/service-library/src/servicelib/aiohttp/requests_validation.py

@@ -10,7 +10,7 @@
 import json.decoder
 from collections.abc import Iterator
 from contextlib import contextmanager
-from typing import TypeVar
+from typing import Final, TypeVar
 
 from aiohttp import web
 from common_library.user_messages import user_message
@@ -23,6 +23,10 @@
 ModelClass = TypeVar("ModelClass", bound=BaseModel)
 ModelOrListOrDictType = TypeVar("ModelOrListOrDictType", bound=BaseModel | list | dict)
 
+APP_JSON_SCHEMA_SPECS_KEY: Final = web.AppKey(
+    "APP_JSON_SCHEMA_SPECS_KEY", dict[str, object]
+)
+
 
 @contextmanager
 def handle_validation_as_http_error(

packages/service-library/src/servicelib/aiohttp/rest_middlewares.py

@@ -5,7 +5,7 @@
 
 import logging
 from collections.abc import Awaitable, Callable
-from typing import Any
+from typing import Any, Final
 
 from aiohttp import web
 from aiohttp.web_exceptions import HTTPError
@@ -298,3 +298,8 @@ def append_rest_middlewares(
     """Helper that appends rest-middlewares in the correct order"""
     app.middlewares.append(error_middleware_factory(api_version))
     app.middlewares.append(envelope_middleware_factory(api_version))
+
+
+APP_JSONSCHEMA_SPECS_KEY: Final = web.AppKey(
+    "APP_JSONSCHEMA_SPECS_KEY", dict[str, object]
+)