refactor: rabbit appkeys

Author: pcrespov

.github/prompts/aiohttp-appkey.prompt.md

@@ -7,18 +7,18 @@ Convert all string-based app key constants to use type-safe web.AppKey.
 
 - Replace patterns like:
   ```python
-  MY_APPKEY: Final[str] = f"{__name__}.my_key"
+  CONSTNAME_APPKEY: Final[str] = f"{__name__}.my_key"
   ```
   with:
   ```python
   from aiohttp import web
-  MY_APPKEY: Final = web.AppKey("MY_APPKEY", MySpecificType)
+  CONSTNAME_APPKEY: Final = web.AppKey("CONSTNAME", ValueType)
   ```
-  (Replace MySpecificType with the actual type stored under this key.)
+  (Replace ValueType with the actual type stored under this key.)
 
 - Update all usages:
-  - `app[MY_APPKEY] = value`
-  - `data = app[MY_APPKEY]` or `data = request.app[MY_APPKEY]`
+  - `app[CONSTNAME_APPKEY] = value`
+  - `data = app[CONSTNAME_APPKEY]` or `data = request.app[CONSTNAME_APPKEY]`
 
 - Key constant MUST be UPPERCASE
 - Key name MUST be suffixed `_APPKEY`

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

@@ -33,8 +33,6 @@
     "APP_FIRE_AND_FORGET_TASKS_KEY", set[asyncio.Task]
 )
 
-APP_RABBITMQ_CLIENT_KEY: Final[str] = f"{__name__}.rabbit_client"
-APP_RABBITMQ_RPC_SERVER_KEY: Final[str] = f"{__name__}.rabbit_rpc_server"
 
 #
 # web.Response keys, i.e. app[RSP_*_KEY]

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

@@ -2,6 +2,7 @@
 import tempfile
 from pathlib import Path
 from pprint import pformat
+from typing import Final
 
 from aiohttp import web
 from models_library.products import ProductName

services/web/server/src/simcore_service_webserver/rabbitmq.py

@@ -1,13 +1,9 @@
 import logging
 from collections.abc import AsyncIterator
-from typing import Final, cast
+from typing import Final
 
 from aiohttp import web
 from models_library.errors import RABBITMQ_CLIENT_UNHEALTHY_MSG
-from servicelib.aiohttp.application_keys import (
-    APP_RABBITMQ_CLIENT_KEY,
-    APP_RABBITMQ_RPC_SERVER_KEY,
-)
 from servicelib.logging_utils import log_context
 from servicelib.rabbitmq import (
     RabbitMQClient,
@@ -21,9 +17,9 @@
 
 _logger = logging.getLogger(__name__)
 
-_RABBITMQ_RPC_CLIENT_APPKEY: Final = web.AppKey(
-    "_RABBITMQ_RPC_CLIENT_APPKEY", RabbitMQRPCClient
-)
+RABBITMQ_CLIENT_APPKEY: Final = web.AppKey("RABBITMQ_CLIENT", RabbitMQClient)
+RABBITMQ_RPC_SERVER_APPKEY: Final = web.AppKey("RABBITMQ_RPC_SERVER", RabbitMQRPCClient)
+RABBITMQ_RPC_CLIENT_APPKEY: Final = web.AppKey("RABBITMQ_RPC_CLIENT", RabbitMQRPCClient)
 
 
 async def _on_healthcheck_async_adapter(app: web.Application) -> None:
@@ -42,8 +38,8 @@ async def _rabbitmq_client_cleanup_ctx(app: web.Application) -> AsyncIterator[No
     with log_context(
         _logger, logging.INFO, msg=f"Connect RabbitMQ clients to {settings.dsn}"
     ):
-        app[APP_RABBITMQ_CLIENT_KEY] = RabbitMQClient("webserver", settings)
-        app[APP_RABBITMQ_RPC_SERVER_KEY] = await RabbitMQRPCClient.create(
+        app[RABBITMQ_CLIENT_APPKEY] = RabbitMQClient("webserver", settings)
+        app[RABBITMQ_RPC_SERVER_APPKEY] = await RabbitMQRPCClient.create(
             client_name="webserver_rpc_server", settings=settings
         )
 
@@ -55,8 +51,8 @@ async def _rabbitmq_client_cleanup_ctx(app: web.Application) -> AsyncIterator[No
 
     # cleanup
     with log_context(_logger, logging.INFO, msg="Close RabbitMQ client"):
-        await app[APP_RABBITMQ_CLIENT_KEY].close()
-        await app[APP_RABBITMQ_RPC_SERVER_KEY].close()
+        await app[RABBITMQ_CLIENT_APPKEY].close()
+        await app[RABBITMQ_RPC_SERVER_APPKEY].close()
 
 
 async def _rabbitmq_rpc_client_lifespan(app: web.Application):
@@ -67,7 +63,7 @@ async def _rabbitmq_rpc_client_lifespan(app: web.Application):
 
     assert rpc_client  # nosec
 
-    app[_RABBITMQ_RPC_CLIENT_APPKEY] = rpc_client
+    app[RABBITMQ_RPC_CLIENT_APPKEY] = rpc_client
 
     yield
 
@@ -87,12 +83,12 @@ def setup_rabbitmq(app: web.Application) -> None:
 
 
 def get_rabbitmq_rpc_client(app: web.Application) -> RabbitMQRPCClient:
-    return cast(RabbitMQRPCClient, app[_RABBITMQ_RPC_CLIENT_APPKEY])
+    return app[RABBITMQ_RPC_CLIENT_APPKEY]
 
 
 def get_rabbitmq_client(app: web.Application) -> RabbitMQClient:
-    return cast(RabbitMQClient, app[APP_RABBITMQ_CLIENT_KEY])
+    return app[RABBITMQ_CLIENT_APPKEY]
 
 
 def get_rabbitmq_rpc_server(app: web.Application) -> RabbitMQRPCClient:
-    return cast(RabbitMQRPCClient, app[APP_RABBITMQ_RPC_SERVER_KEY])
+    return app[RABBITMQ_RPC_SERVER_APPKEY]