✨ Update WEBSERVER_RPC_NAMESPACE usage and improve settings documentation

Author: pcrespov

packages/models-library/src/models_library/api_schemas_webserver/__init__.py

@@ -5,5 +5,6 @@
 from ..rabbitmq_basic_types import RPCNamespace
 
 WEBSERVER_RPC_NAMESPACE: Final[RPCNamespace] = TypeAdapter(
+    # NOTE: deprecated! Use app.state.settings.WEBSERVER_RPC_NAMESPACE
     RPCNamespace
 ).validate_python("webserver")

packages/service-library/src/servicelib/rabbitmq/rpc_interfaces/webserver/v1/client.py

@@ -1,7 +1,6 @@
 """Main WebServer RPC Client."""
 
 from models_library.rabbitmq_basic_types import RPCNamespace
-from models_library.rpc.webserver import WEBSERVER_RPC_NAMESPACE
 from servicelib.rabbitmq import RabbitMQRPCClient
 
 from .api_keys import ApiKeysRpcApi
@@ -16,7 +15,7 @@ class WebServerRpcClient:
     def __init__(
         self,
         rpc_client: RabbitMQRPCClient,
-        namespace: RPCNamespace = WEBSERVER_RPC_NAMESPACE,
+        namespace: RPCNamespace,
     ):
         self._rpc_client = rpc_client
         self._namespace = namespace

services/api-server/.env-devel

@@ -35,8 +35,9 @@ RABBIT_PORT=5672
 RABBIT_SECURE=false
 RABBIT_USER=admin
 
-# webserver
-WEBSERVER_HOST=webserver
+# webserver (WB_API_WEBSERVER_HOST)
+WEBSERVER_HOST=wb-api-server
+WEBSERVER_RPC_NAMESPACE=wb-api-server
 # Take from general .env-devel
 WEBSERVER_SESSION_SECRET_KEY='REPLACE_ME_with_result__Fernet_generate_key='
 

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

@@ -4,6 +4,7 @@
 from common_library.basic_types import DEFAULT_FACTORY
 from common_library.logging.logging_utils_filtering import LoggerName, MessageSubstring
 from models_library.basic_types import BootModeEnum, LogLevel
+from models_library.rabbitmq_basic_types import RPCNamespace
 from pydantic import (
     AliasChoices,
     Field,
@@ -41,6 +42,11 @@ class WebServerSettings(WebServerBaseSettings, MixinSessionSettings):
     ]
     WEBSERVER_SESSION_NAME: str = DEFAULT_SESSION_COOKIE_NAME
 
+    WEBSERVER_RPC_NAMESPACE: Annotated[
+        RPCNamespace,
+        Field(description="Namespace for the RPC server"),
+    ]
+
     @field_validator("WEBSERVER_SESSION_SECRET_KEY")
     @classmethod
     def _check_valid_fernet_key(cls, v):

services/api-server/src/simcore_service_api_server/services_rpc/wb_api_server.py

@@ -65,7 +65,6 @@
 from servicelib.rabbitmq.rpc_interfaces.resource_usage_tracker.errors import (
     NotEnoughAvailableSeatsError,
 )
-from servicelib.rabbitmq.rpc_interfaces.webserver import projects as projects_rpc
 from servicelib.rabbitmq.rpc_interfaces.webserver.errors import (
     ProjectForbiddenRpcError,
     ProjectNotFoundRpcError,
@@ -85,10 +84,13 @@
 from servicelib.rabbitmq.rpc_interfaces.webserver.licenses.licensed_items import (
     release_licensed_item_for_wallet as _release_licensed_item_for_wallet,
 )
+from servicelib.rabbitmq.rpc_interfaces.webserver.v1 import WebServerRpcClient
 from simcore_service_api_server.models.basic_types import NameValueTuple
 
+from ..core.settings import WebServerSettings
 from ..exceptions.backend_errors import (
     CanNotCheckoutServiceIsNotRunningError,
+    ConfigurationError,
     InsufficientNumberOfSeatsError,
     JobForbiddenAccessError,
     JobNotFoundError,
@@ -138,6 +140,7 @@ def _create_licensed_items_get_page(
 class WbApiRpcClient(SingletonInAppStateMixin):
     app_state_name = "wb_api_rpc_client"
     _client: RabbitMQRPCClient
+    _rpc_client: WebServerRpcClient
 
     @_exception_mapper(rpc_exception_map={})
     async def get_licensed_items(
@@ -253,8 +256,7 @@ async def mark_project_as_job(
         job_parent_resource_name: RelativeResourceName,
         storage_assets_deleted: bool,  # noqa: FBT001
     ):
-        await projects_rpc.mark_project_as_job(
-            rpc_client=self._client,
+        await self._rpc_client.projects.mark_project_as_job(
             product_name=product_name,
             user_id=user_id,
             project_uuid=project_uuid,
@@ -276,8 +278,7 @@ async def get_project_marked_as_job(
         project_id: ProjectID,
         job_parent_resource_name: RelativeResourceName,
     ) -> ProjectJobRpcGet:
-        return await projects_rpc.get_project_marked_as_job(
-            rpc_client=self._client,
+        return await self._rpc_client.projects.get_project_marked_as_job(
             product_name=product_name,
             user_id=user_id,
             project_uuid=project_id,
@@ -310,8 +311,7 @@ async def list_projects_marked_as_jobs(
             ),
         )
 
-        return await projects_rpc.list_projects_marked_as_jobs(
-            rpc_client=self._client,
+        return await self._rpc_client.projects.list_projects_marked_as_jobs(
             product_name=product_name,
             user_id=user_id,
             filters=filters,
@@ -702,5 +702,14 @@ async def get_functions_user_api_access_rights(
 
 
 def setup(app: FastAPI, rabbitmq_rmp_client: RabbitMQRPCClient):
-    wb_api_rpc_client = WbApiRpcClient(_client=rabbitmq_rmp_client)
+    webserver_settings: WebServerSettings = app.state.settings.API_SERVER_WEBSERVER
+    if not webserver_settings:
+        raise ConfigurationError(tip="Webserver settings are not configured")
+
+    wb_api_rpc_client = WbApiRpcClient(
+        _client=rabbitmq_rmp_client,
+        _rpc_client=WebServerRpcClient(
+            rabbitmq_rmp_client, webserver_settings.WEBSERVER_RPC_NAMESPACE
+        ),
+    )
     wb_api_rpc_client.set_to_app_state(app=app)

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

@@ -157,7 +157,7 @@ class ApplicationSettings(BaseApplicationSettings, MixinLoggingSettings):
 
     WEBSERVER_RPC_NAMESPACE: Annotated[
         RPCNamespace | None,
-        Field(description="Namespace for the RPC service, if any, otherwise None"),
+        Field(description="Namespace for the RPC server (if any) otherwise None"),
     ]
 
     WEBSERVER_SERVER_HOST: Annotated[

services/web/server/src/simcore_service_webserver/projects/_controller/projects_rpc.py

@@ -14,7 +14,6 @@
     ProjectForbiddenRpcError,
     ProjectNotFoundRpcError,
 )
-from simcore_service_storage.core.settings import get_application_settings
 
 from ...application_settings import get_application_settings
 from ...rabbitmq import get_rabbitmq_rpc_server