Merge branch 'fix/web-server-rpc-namespace' of github.com:pcrespov/osparc-simcore into fix/web-server-rpc-namespace

Author: pcrespov

packages/service-library/src/servicelib/rabbitmq/rpc_interfaces/webserver/functions/functions_rpc_interface.py

@@ -28,9 +28,8 @@
     RegisteredFunctionJobWithStatus,
 )
 from models_library.products import ProductName
-from models_library.rest_ordering import OrderBy
-
 from models_library.rabbitmq_basic_types import RPCMethodName, RPCNamespace
+from models_library.rest_ordering import OrderBy
 from models_library.rest_pagination import PageMetaInfoLimitOffset
 from models_library.users import UserID
 from pydantic import TypeAdapter
@@ -201,7 +200,7 @@ async def list_function_jobs(
 
 @log_decorator(_logger, level=logging.DEBUG)
 async def list_function_jobs_with_status(
-    rabbitmq_rpc_client: RabbitMQRPCClient,
+    rpc_client: RabbitMQRPCClient,
     *,
     user_id: UserID,
     product_name: ProductName,
@@ -214,7 +213,7 @@ async def list_function_jobs_with_status(
     list[RegisteredFunctionJobWithStatus],
     PageMetaInfoLimitOffset,
 ]:
-    result = await rabbitmq_rpc_client.request(
+    result = await rpc_client.request(
         WEBSERVER_RPC_NAMESPACE,
         TypeAdapter(RPCMethodName).validate_python("list_function_jobs_with_status"),
         user_id=user_id,
@@ -341,14 +340,14 @@ async def register_function_job(
 
 @log_decorator(_logger, level=logging.DEBUG)
 async def patch_registered_function_job(
-    rabbitmq_rpc_client: RabbitMQRPCClient,
+    rpc_client: RabbitMQRPCClient,
     *,
     user_id: UserID,
     product_name: ProductName,
     function_job_uuid: FunctionJobID,
     registered_function_job_patch: RegisteredFunctionJobPatch,
 ) -> RegisteredFunctionJob:
-    result = await rabbitmq_rpc_client.request(
+    result = await rpc_client.request(
         WEBSERVER_RPC_NAMESPACE,
         TypeAdapter(RPCMethodName).validate_python("patch_registered_function_job"),
         user_id=user_id,

services/api-server/src/simcore_service_api_server/core/settings.py

@@ -148,14 +148,15 @@ class ApplicationSettings(BasicSettings):
         ),
     ]
 
-    API_SERVER_WORKER_MODE: Annotated[
-        bool, Field(description="If True, the API server runs in worker mode")
-    ] = False
     API_SERVER_WEBSERVER_RPC_NAMESPACE: Annotated[
         RPCNamespace,
         Field(description="Namespace to connect to correct webserver's RPC interface"),
     ]
 
+    API_SERVER_WORKER_MODE: Annotated[
+        bool, Field(description="If True, the API server runs in worker mode")
+    ] = False
+
     @cached_property
     def debug(self) -> bool:
         """If True, debug tracebacks should be returned on errors."""

services/director-v2/src/simcore_service_director_v2/core/settings.py

@@ -300,6 +300,11 @@ class AppSettings(BaseApplicationSettings, MixinLoggingSettings):
         Field(description="Namespace to connect to correct webserver's RPC interface"),
     ]
 
+    DIRECTOR_V2_WEBSERVER_RPC_NAMESPACE: Annotated[
+        RPCNamespace,
+        Field(description="Namespace to connect to correct webserver's RPC interface"),
+    ]
+
     @field_validator("LOG_LEVEL", mode="before")
     @classmethod
     def _validate_loglevel(cls, value: str) -> str:

services/docker-compose.yml

@@ -522,6 +522,7 @@ services:
       PAYMENTS_SWAGGER_API_DOC_ENABLED: ${PAYMENTS_SWAGGER_API_DOC_ENABLED}
       PAYMENTS_TRACING: ${PAYMENTS_TRACING}
       PAYMENTS_USERNAME: ${PAYMENTS_USERNAME}
+      PAYMENTS_WEBSERVER_RPC_NAMESPACE: ${WEBSERVER_HOST}
       RABBIT_HOST: ${RABBIT_HOST}
       RABBIT_PASSWORD: ${RABBIT_PASSWORD}
       RABBIT_PORT: ${RABBIT_PORT}

services/web/server/src/simcore_service_webserver/payments/_rpc_invoice.py

@@ -9,8 +9,8 @@
 
 from ..products import products_service
 from ..products.models import CreditResult
-from ..users import users_service
 from ..rabbitmq import create_register_rpc_routes_on_startup
+from ..users import users_service
 
 router = RPCRouter()
 

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

@@ -5,6 +5,7 @@
 from aiohttp import web
 from models_library.api_schemas_webserver import get_webserver_rpc_namespace
 from models_library.errors import RABBITMQ_CLIENT_UNHEALTHY_MSG
+from models_library.rabbitmq_basic_types import RPCNamespace
 from servicelib.aiohttp.application_keys import (
     APP_RABBITMQ_CLIENT_KEY,
     APP_RABBITMQ_RPC_SERVER_KEY,
@@ -98,6 +99,13 @@ def get_rabbitmq_rpc_server(app: web.Application) -> RabbitMQRPCClient:
     return cast(RabbitMQRPCClient, app[APP_RABBITMQ_RPC_SERVER_KEY])
 
 
+def get_rpc_namespace(app: web.Application) -> RPCNamespace:
+    settings = get_application_settings(app)
+
+    assert settings.WEBSERVER_HOST  # nosec
+    return get_webserver_rpc_namespace(settings.WEBSERVER_HOST)
+
+
 def create_register_rpc_routes_on_startup(router: RPCRouter):
     """
     This high-order function allows for more flexible router registration
@@ -110,10 +118,7 @@ def create_register_rpc_routes_on_startup(router: RPCRouter):
 
     async def _on_startup(app: web.Application):
         rpc_server = get_rabbitmq_rpc_server(app)
-        settings = get_application_settings(app)
-
-        assert settings.WEBSERVER_HOST  # nosec
-        rpc_namespace = get_webserver_rpc_namespace(settings.WEBSERVER_HOST)
+        rpc_namespace = get_rpc_namespace(app)
         await rpc_server.register_router(router, rpc_namespace, app)
 
     return _on_startup

services/web/server/tests/unit/with_dbs/01/test_api_keys_rpc.py

@@ -6,7 +6,7 @@
 from collections.abc import AsyncIterable, Awaitable, Callable
 
 import pytest
-from aiohttp.test_utils import TestServer
+from aiohttp.test_utils import TestClient, TestServer
 from faker import Faker
 from models_library.basic_types import IDStr
 from models_library.products import ProductName
@@ -15,7 +15,7 @@
 from pytest_simcore.helpers.monkeypatch_envs import setenvs_from_dict
 from pytest_simcore.helpers.typing_env import EnvVarsDict
 from pytest_simcore.helpers.webserver_users import UserInfoDict
-from servicelib.rabbitmq import RabbitMQRPCClient
+from servicelib.rabbitmq import RabbitMQRPCClient, RPCNamespace
 from servicelib.rabbitmq.rpc_interfaces.webserver.auth.api_keys import (
     create_api_key,
     delete_api_key_by_key,
@@ -27,6 +27,7 @@
 from simcore_service_webserver.api_keys.errors import ApiKeyNotFoundError
 from simcore_service_webserver.api_keys.models import ApiKey
 from simcore_service_webserver.application_settings import ApplicationSettings
+from simcore_service_webserver.rabbitmq import get_rpc_namespace
 
 pytest_simcore_core_services_selection = [
     "rabbit",
@@ -104,15 +105,23 @@ async def rpc_client(
     return await rabbitmq_rpc_client("client")
 
 
+@pytest.fixture
+async def app_rpc_namespace(client: TestClient) -> RPCNamespace:
+    assert client.app is not None
+    return get_rpc_namespace(client.app)
+
+
 async def test_get_api_key(
     fake_user_api_keys: list[ApiKey],
     rpc_client: RabbitMQRPCClient,
     osparc_product_name: ProductName,
     logged_user: UserInfoDict,
+    app_rpc_namespace: RPCNamespace,
 ):
     for api_key in fake_user_api_keys:
         result = await get_api_key(
             rpc_client,
+            app_rpc_namespace,
             user_id=logged_user["id"],
             product_name=osparc_product_name,
             api_key_id=IDStr(api_key.id),
@@ -121,17 +130,18 @@ async def test_get_api_key(
 
 
 async def test_api_keys_workflow(
-    web_server: TestServer,
     rpc_client: RabbitMQRPCClient,
     osparc_product_name: ProductName,
     logged_user: UserInfoDict,
+    app_rpc_namespace: RPCNamespace,
     faker: Faker,
 ):
     key_name = faker.pystr()
 
     # creating a key
     created_api_key = await create_api_key(
         rpc_client,
+        app_rpc_namespace,
         user_id=logged_user["id"],
         product_name=osparc_product_name,
         api_key=ApiKeyCreate(display_name=key_name, expiration=None),
@@ -141,6 +151,7 @@ async def test_api_keys_workflow(
     # query the key is still present
     queried_api_key = await get_api_key(
         rpc_client,
+        app_rpc_namespace,
         product_name=osparc_product_name,
         user_id=logged_user["id"],
         api_key_id=created_api_key.id,
@@ -155,6 +166,7 @@ async def test_api_keys_workflow(
     # remove the key
     await delete_api_key_by_key(
         rpc_client,
+        app_rpc_namespace,
         user_id=logged_user["id"],
         product_name=osparc_product_name,
         api_key=created_api_key.api_key,
@@ -164,6 +176,7 @@ async def test_api_keys_workflow(
         # key no longer present
         await get_api_key(
             rpc_client,
+            app_rpc_namespace,
             product_name=osparc_product_name,
             user_id=logged_user["id"],
             api_key_id=created_api_key.id,

services/web/server/tests/unit/with_dbs/04/functions/test_function_jobs_controller_rpc.py

@@ -266,7 +266,7 @@ async def test_list_function_jobs_with_status(
 
     # List function jobs
     jobs, _ = await functions_rpc.list_function_jobs_with_status(
-        rabbitmq_rpc_client=rpc_client,
+        rpc_client=rpc_client,
         pagination_limit=10,
         pagination_offset=0,
         user_id=logged_user["id"],
@@ -574,7 +574,7 @@ async def test_patch_registered_function_jobs(
     )
 
     registered_job = await functions_rpc.patch_registered_function_job(
-        rabbitmq_rpc_client=rpc_client,
+        rpc_client=rpc_client,
         user_id=logged_user["id"],
         function_job_uuid=registered_job.uid,
         product_name=osparc_product_name,
@@ -651,7 +651,7 @@ async def test_incompatible_patch_model_error(
     )
     with pytest.raises(FunctionJobPatchModelIncompatibleError):
         registered_job = await functions_rpc.patch_registered_function_job(
-            rabbitmq_rpc_client=rpc_client,
+            rpc_client=rpc_client,
             user_id=logged_user["id"],
             function_job_uuid=registered_job.uid,
             product_name=osparc_product_name,