🎨 Refactor socket server key definitions for consistency

Author: pcrespov

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

@@ -2,42 +2,46 @@
 from collections.abc import Awaitable, Callable
 from functools import wraps
 from types import ModuleType
-from typing import Any, Final
+from typing import Any, Final, TypeAlias
 
 from aiohttp import web
 from socketio import AsyncServer  # type: ignore[import-untyped]
 
-APP_CLIENT_SOCKET_DECORATED_HANDLERS_APPKEY: Final = web.AppKey(
+_CLIENT_SOCKET_DECORATED_HANDLERS_APPKEY: Final = web.AppKey(
     "APP_CLIENT_SOCKET_DECORATED_HANDLERS", list[Callable]
 )
-APP_CLIENT_SOCKET_SERVER_APPKEY: Final = web.AppKey(
+CLIENT_SOCKET_SERVER_APPKEY: Final = web.AppKey(
     # NOTE: AsyncServer stub library is missing
     "APP_CLIENT_SOCKET_SERVER",
     AsyncServer,  # type: ignore[var-annotated]
 )
 
 
 def get_socket_server(app: web.Application) -> AsyncServer:
-    return app[APP_CLIENT_SOCKET_SERVER_APPKEY]
+    return app[CLIENT_SOCKET_SERVER_APPKEY]
 
 
 # The socket ID that was assigned to the client
-SocketID = str
+SocketID: TypeAlias = str
 
 # The environ argument is a dictionary in standard WSGI format containing the request information, including HTTP headers
-EnvironDict = dict[str, Any]
+EnvironDict: TypeAlias = dict[str, Any]
 
 # Connect event
-SocketioConnectEventHandler = Callable[
+SocketioConnectEventHandler: TypeAlias = Callable[
     [SocketID, EnvironDict, web.Application], Awaitable[None]
 ]
 
 # Disconnect event
-SocketioDisconnectEventHandler = Callable[[SocketID, web.Application], Awaitable[None]]
+SocketioDisconnectEventHandler: TypeAlias = Callable[
+    [SocketID, web.Application], Awaitable[None]
+]
 
 # Event
-AnyData = Any
-SocketioEventHandler = Callable[[SocketID, AnyData, web.Application], Awaitable[None]]
+AnyData: TypeAlias = Any
+SocketioEventHandler: TypeAlias = Callable[
+    [SocketID, AnyData, web.Application], Awaitable[None]
+]
 
 _socketio_handlers_registry: list[
     (
@@ -82,7 +86,7 @@ def register_socketio_handlers(app: web.Application, module: ModuleType):
     partial_fcts = [
         _socket_io_handler(app)(func_handler) for func_handler in member_fcts
     ]
-    app[APP_CLIENT_SOCKET_DECORATED_HANDLERS_APPKEY] = partial_fcts
+    app[_CLIENT_SOCKET_DECORATED_HANDLERS_APPKEY] = partial_fcts
 
     # register the fcts
     for func in partial_fcts:

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_APPKEY,
+    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_APPKEY] = sio_server
+    app[CLIENT_SOCKET_SERVER_APPKEY] = sio_server
 
     register_socketio_handlers(app, _handlers)