🎨 Refactor long-running tasks context key to use LONG_RUNNING_TASKS_CONTEXT_REQKEY for consistency

Author: pcrespov

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

@@ -1,4 +1,4 @@
 from . import server
-from ._request import RQT_LONG_RUNNING_TASKS_CONTEXT_APPKEY
+from ._request import LONG_RUNNING_TASKS_CONTEXT_REQKEY
 
-__all__ = ("server", "RQT_LONG_RUNNING_TASKS_CONTEXT_APPKEY")
+__all__ = ("server", "LONG_RUNNING_TASKS_CONTEXT_REQKEY")

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

@@ -2,10 +2,9 @@
 
 from aiohttp import web
 
-RQT_LONG_RUNNING_TASKS_CONTEXT_APPKEY: Final = web.AppKey(
-    "RQT_LONG_RUNNING_TASKS_CONTEXT", dict[str, Any]
-)
+LONG_RUNNING_TASKS_CONTEXT_REQKEY: Final = f"{__name__}.LONG_RUNNING_TASKS_CONTEXT"
 
 
 def get_task_context(request: web.Request) -> dict[str, Any]:
-    return request[RQT_LONG_RUNNING_TASKS_CONTEXT_APPKEY]
+    ctx: dict[str, Any] = request[LONG_RUNNING_TASKS_CONTEXT_REQKEY]
+    return ctx

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

@@ -36,7 +36,7 @@
     get_long_running_manager,
 )
 from ._request import (
-    RQT_LONG_RUNNING_TASKS_CONTEXT_APPKEY,
+    LONG_RUNNING_TASKS_CONTEXT_REQKEY,
 )
 
 
@@ -47,7 +47,7 @@ def _no_ops_decorator(handler: Handler):
 def _no_task_context_decorator(handler: Handler):
     @wraps(handler)
     async def _wrap(request: web.Request):
-        request[RQT_LONG_RUNNING_TASKS_CONTEXT_APPKEY] = {}
+        request[LONG_RUNNING_TASKS_CONTEXT_REQKEY] = {}
         return await handler(request)
 
     return _wrap

packages/service-library/tests/aiohttp/long_running_tasks/test_long_running_tasks_with_task_context.py

@@ -20,7 +20,7 @@
 from pytest_simcore.helpers.assert_checks import assert_status
 from servicelib.aiohttp import long_running_tasks, status
 from servicelib.aiohttp.long_running_tasks._request import (
-    RQT_LONG_RUNNING_TASKS_CONTEXT_APPKEY,
+    LONG_RUNNING_TASKS_CONTEXT_REQKEY,
 )
 from servicelib.aiohttp.requests_validation import parse_request_query_parameters_as
 from servicelib.aiohttp.rest_middlewares import append_rest_middlewares
@@ -56,7 +56,7 @@ async def _test_task_context_decorator(
         ) -> web.StreamResponse:
             """this task context callback tries to get the user_id from the query if available"""
             query_param = parse_request_query_parameters_as(query_model, request)
-            request[RQT_LONG_RUNNING_TASKS_CONTEXT_APPKEY] = query_param.model_dump()
+            request[LONG_RUNNING_TASKS_CONTEXT_REQKEY] = query_param.model_dump()
             return await handler(request)
 
         return _test_task_context_decorator

services/web/server/src/simcore_service_webserver/long_running_tasks/plugin.py

@@ -2,9 +2,8 @@
 from functools import wraps
 
 from aiohttp import web
-from models_library.utils.fastapi_encoders import jsonable_encoder
 from servicelib.aiohttp.long_running_tasks import (
-    RQT_LONG_RUNNING_TASKS_CONTEXT_APPKEY,
+    LONG_RUNNING_TASKS_CONTEXT_REQKEY,
 )
 from servicelib.aiohttp.long_running_tasks.server import setup
 from servicelib.aiohttp.typing_extension import Handler
@@ -31,7 +30,7 @@ async def _test_task_context_decorator(
     ) -> web.StreamResponse:
         """this task context callback tries to get the user_id from the query if available"""
         req_ctx = AuthenticatedRequestContext.model_validate(request)
-        request[RQT_LONG_RUNNING_TASKS_CONTEXT_APPKEY] = jsonable_encoder(req_ctx)
+        request[LONG_RUNNING_TASKS_CONTEXT_REQKEY] = req_ctx.model_dump(mode="json")
         return await handler(request)
 
     return _test_task_context_decorator

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

@@ -1,6 +1,6 @@
 import asyncio
 import logging
-from typing import Final, Protocol, cast
+from typing import Final, Protocol
 
 from aiohttp import web
 from models_library.api_schemas_webserver.permalinks import ProjectPermalink
@@ -37,7 +37,7 @@ def register_factory(app: web.Application, factory_coro: CreateLinkCoroutine):
 
 def _get_factory(app: web.Application) -> CreateLinkCoroutine:
     if _create := app.get(_PROJECT_PERMALINK_FACTORY_APPKEY):
-        return cast(CreateLinkCoroutine, _create)
+        return _create
 
     msg = "Undefined permalink factory. Check plugin initialization."
     raise PermalinkFactoryError(msg)

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

@@ -10,7 +10,7 @@
 from ..rabbitmq_settings import get_plugin_settings as get_rabbitmq_settings
 from . import _handlers
 from ._utils import (
-    APP_CLIENT_SOCKET_SERVER_KEY,
+    APP_CLIENT_SOCKET_SERVER_APPKEY,
     get_socket_server,
     register_socketio_handlers,
 )
@@ -30,7 +30,7 @@ async def _socketio_server_cleanup_ctx(app: web.Application) -> AsyncIterator[No
     )
     sio_server.attach(app)
 
-    app[APP_CLIENT_SOCKET_SERVER_KEY] = sio_server
+    app[APP_CLIENT_SOCKET_SERVER_APPKEY] = sio_server
 
     register_socketio_handlers(app, _handlers)