🎨 New rpc client in the api-server to avoid cross-service calls with the web-server variants (🚨)

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

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

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

@@ -3,7 +3,7 @@
 
 from models_library.basic_types import IDStr
 from models_library.resource_tracker import PricingPlanId
-from pydantic import BaseModel, ConfigDict, HttpUrl, PositiveInt
+from pydantic import BaseModel, ConfigDict, HttpUrl, NonNegativeInt, PositiveInt
 from pydantic.config import JsonDict
 from typing_extensions import TypedDict
 
@@ -94,7 +94,7 @@ class LicensedItemRpcGet(BaseModel):
 
 class LicensedItemRpcGetPage(NamedTuple):
     items: list[LicensedItemRpcGet]
-    total: PositiveInt
+    total: NonNegativeInt
 
 
 # Rest

packages/models-library/src/models_library/rpc/webserver/__init__.py

@@ -0,0 +1,4 @@
+from ...api_schemas_webserver import DEFAULT_WEBSERVER_RPC_NAMESPACE
+
+__all__: tuple[str, ...] = ("DEFAULT_WEBSERVER_RPC_NAMESPACE",)
+# nopycln" file

packages/pytest-simcore/src/pytest_simcore/helpers/typing_mock.py

@@ -0,0 +1,14 @@
+from collections.abc import Callable
+from typing import Any, Protocol
+
+from pytest_mock import MockType
+
+
+class HandlerMockFactory(Protocol):
+    def __call__(
+        self,
+        handler_name: str,
+        return_value: Any = None,
+        exception: Exception | None = None,
+        side_effect: Callable | None = None,
+    ) -> MockType: ...

packages/pytest-simcore/src/pytest_simcore/helpers/webserver_rpc_server.py

@@ -26,13 +26,8 @@
 class WebserverRpcSideEffects:
     # pylint: disable=no-self-use
 
-    def __init__(
-        self,
-        project_job_rpc_get: ProjectJobRpcGet = ProjectJobRpcGet.model_validate(
-            ProjectJobRpcGet.model_json_schema()["examples"][0]
-        ),
-    ):
-        self.project_job_rpc_get = project_job_rpc_get
+    def __init__(self, fake_project_job_rpc_get: ProjectJobRpcGet):
+        self.fake_project_job_rpc_get = fake_project_job_rpc_get
 
     @validate_call(config={"arbitrary_types_allowed": True})
     async def mark_project_as_job(
@@ -112,7 +107,7 @@ async def get_project_marked_as_job(
         assert job_parent_resource_name
 
         # Return a valid example from the schema
-        _data = self.project_job_rpc_get.model_dump()
+        _data = self.fake_project_job_rpc_get.model_dump()
         _data["uuid"] = str(project_uuid)
         _data["job_parent_resource_name"] = job_parent_resource_name
         return ProjectJobRpcGet.model_validate(_data)

packages/service-library/src/servicelib/rabbitmq/rpc_interfaces/webserver/auth/api_keys.py

@@ -1,6 +1,7 @@
 import logging
+import warnings
 
-from models_library.api_schemas_webserver import WEBSERVER_RPC_NAMESPACE
+from models_library.api_schemas_webserver import DEFAULT_WEBSERVER_RPC_NAMESPACE
 from models_library.basic_types import IDStr
 from models_library.rabbitmq_basic_types import RPCMethodName
 from models_library.rpc.webserver.auth.api_keys import ApiKeyCreate, ApiKeyGet
@@ -12,6 +13,13 @@
 
 _logger = logging.getLogger(__name__)
 
+warnings.warn(
+    f"The '{__name__}' module is deprecated and will be removed in a future release. "
+    "Please use 'rpc_interfaces.webserver.v1' instead.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
 
 @log_decorator(_logger, level=logging.DEBUG)
 async def create_api_key(
@@ -22,7 +30,7 @@ async def create_api_key(
     api_key: ApiKeyCreate,
 ) -> ApiKeyGet:
     result: ApiKeyGet = await rabbitmq_rpc_client.request(
-        WEBSERVER_RPC_NAMESPACE,
+        DEFAULT_WEBSERVER_RPC_NAMESPACE,
         TypeAdapter(RPCMethodName).validate_python("create_api_key"),
         user_id=user_id,
         product_name=product_name,
@@ -42,7 +50,7 @@ async def get_api_key(
     api_key_id: IDStr,
 ) -> ApiKeyGet:
     result: ApiKeyGet = await rabbitmq_rpc_client.request(
-        WEBSERVER_RPC_NAMESPACE,
+        DEFAULT_WEBSERVER_RPC_NAMESPACE,
         TypeAdapter(RPCMethodName).validate_python("get_api_key"),
         user_id=user_id,
         product_name=product_name,
@@ -61,7 +69,7 @@ async def delete_api_key_by_key(
     api_key: str,
 ) -> None:
     result = await rabbitmq_rpc_client.request(
-        WEBSERVER_RPC_NAMESPACE,
+        DEFAULT_WEBSERVER_RPC_NAMESPACE,
         TypeAdapter(RPCMethodName).validate_python("delete_api_key_by_key"),
         user_id=user_id,
         product_name=product_name,

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

@@ -1,7 +1,8 @@
 import logging
+import warnings
 from typing import Annotated, Literal
 
-from models_library.api_schemas_webserver import WEBSERVER_RPC_NAMESPACE
+from models_library.api_schemas_webserver import DEFAULT_WEBSERVER_RPC_NAMESPACE
 from models_library.api_schemas_webserver.functions import (
     Function,
     FunctionID,
@@ -42,6 +43,14 @@
 _FUNCTION_RPC_TIMEOUT_SEC: Annotated[int, PositiveInt] = 30
 
 
+warnings.warn(
+    f"The '{__name__}' module is deprecated and will be removed in a future release. "
+    "Please use 'rpc_interfaces.webserver.v1' instead.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
+
 @log_decorator(_logger, level=logging.DEBUG)
 async def register_function(
     rabbitmq_rpc_client: RabbitMQRPCClient,
@@ -51,7 +60,7 @@ async def register_function(
     function: Function,
 ) -> RegisteredFunction:
     result = await rabbitmq_rpc_client.request(
-        WEBSERVER_RPC_NAMESPACE,
+        DEFAULT_WEBSERVER_RPC_NAMESPACE,
         TypeAdapter(RPCMethodName).validate_python("register_function"),
         function=function,
         user_id=user_id,
@@ -72,7 +81,7 @@ async def get_function(
     function_id: FunctionID,
 ) -> RegisteredFunction:
     result = await rabbitmq_rpc_client.request(
-        WEBSERVER_RPC_NAMESPACE,
+        DEFAULT_WEBSERVER_RPC_NAMESPACE,
         TypeAdapter(RPCMethodName).validate_python("get_function"),
         function_id=function_id,
         user_id=user_id,
@@ -91,7 +100,7 @@ async def get_function_input_schema(
     product_name: ProductName,
 ) -> FunctionInputSchema:
     result = await rabbitmq_rpc_client.request(
-        WEBSERVER_RPC_NAMESPACE,
+        DEFAULT_WEBSERVER_RPC_NAMESPACE,
         TypeAdapter(RPCMethodName).validate_python("get_function_input_schema"),
         function_id=function_id,
         user_id=user_id,
@@ -110,7 +119,7 @@ async def get_function_output_schema(
     product_name: ProductName,
 ) -> FunctionOutputSchema:
     result = await rabbitmq_rpc_client.request(
-        WEBSERVER_RPC_NAMESPACE,
+        DEFAULT_WEBSERVER_RPC_NAMESPACE,
         TypeAdapter(RPCMethodName).validate_python("get_function_output_schema"),
         function_id=function_id,
         user_id=user_id,
@@ -129,7 +138,7 @@ async def delete_function(
     product_name: ProductName,
 ) -> None:
     result = await rabbitmq_rpc_client.request(
-        WEBSERVER_RPC_NAMESPACE,
+        DEFAULT_WEBSERVER_RPC_NAMESPACE,
         TypeAdapter(RPCMethodName).validate_python("delete_function"),
         function_id=function_id,
         user_id=user_id,
@@ -155,7 +164,7 @@ async def list_functions(
 ) -> tuple[list[RegisteredFunction], PageMetaInfoLimitOffset]:
     result: tuple[list[RegisteredFunction], PageMetaInfoLimitOffset] = (
         await rabbitmq_rpc_client.request(
-            WEBSERVER_RPC_NAMESPACE,
+            DEFAULT_WEBSERVER_RPC_NAMESPACE,
             TypeAdapter(RPCMethodName).validate_python("list_functions"),
             pagination_offset=pagination_offset,
             pagination_limit=pagination_limit,
@@ -187,7 +196,7 @@ async def list_function_jobs(
 ) -> tuple[list[RegisteredFunctionJob], PageMetaInfoLimitOffset]:
     result: tuple[list[RegisteredFunctionJob], PageMetaInfoLimitOffset] = (
         await rabbitmq_rpc_client.request(
-            WEBSERVER_RPC_NAMESPACE,
+            DEFAULT_WEBSERVER_RPC_NAMESPACE,
             TypeAdapter(RPCMethodName).validate_python("list_function_jobs"),
             user_id=user_id,
             product_name=product_name,
@@ -220,7 +229,7 @@ async def list_function_jobs_with_status(
     PageMetaInfoLimitOffset,
 ]:
     result = await rabbitmq_rpc_client.request(
-        WEBSERVER_RPC_NAMESPACE,
+        DEFAULT_WEBSERVER_RPC_NAMESPACE,
         TypeAdapter(RPCMethodName).validate_python("list_function_jobs_with_status"),
         user_id=user_id,
         product_name=product_name,
@@ -250,7 +259,7 @@ async def list_function_job_collections(
     filters: FunctionJobCollectionsListFilters | None = None,
 ) -> tuple[list[RegisteredFunctionJobCollection], PageMetaInfoLimitOffset]:
     result = await rabbitmq_rpc_client.request(
-        WEBSERVER_RPC_NAMESPACE,
+        DEFAULT_WEBSERVER_RPC_NAMESPACE,
         TypeAdapter(RPCMethodName).validate_python("list_function_job_collections"),
         pagination_offset=pagination_offset,
         pagination_limit=pagination_limit,
@@ -274,7 +283,7 @@ async def update_function_title(
     title: str,
 ) -> RegisteredFunction:
     result = await rabbitmq_rpc_client.request(
-        WEBSERVER_RPC_NAMESPACE,
+        DEFAULT_WEBSERVER_RPC_NAMESPACE,
         TypeAdapter(RPCMethodName).validate_python("update_function_title"),
         function_id=function_id,
         title=title,
@@ -295,7 +304,7 @@ async def update_function_description(
     description: str,
 ) -> RegisteredFunction:
     result = await rabbitmq_rpc_client.request(
-        WEBSERVER_RPC_NAMESPACE,
+        DEFAULT_WEBSERVER_RPC_NAMESPACE,
         TypeAdapter(RPCMethodName).validate_python("update_function_description"),
         function_id=function_id,
         description=description,
@@ -316,7 +325,7 @@ async def run_function(
     product_name: ProductName,
 ) -> RegisteredFunctionJob:
     result = await rabbitmq_rpc_client.request(
-        WEBSERVER_RPC_NAMESPACE,
+        DEFAULT_WEBSERVER_RPC_NAMESPACE,
         TypeAdapter(RPCMethodName).validate_python("run_function"),
         function_id=function_id,
         inputs=inputs,
@@ -338,7 +347,7 @@ async def register_function_job(
     function_job: FunctionJob,
 ) -> RegisteredFunctionJob:
     result = await rabbitmq_rpc_client.request(
-        WEBSERVER_RPC_NAMESPACE,
+        DEFAULT_WEBSERVER_RPC_NAMESPACE,
         TypeAdapter(RPCMethodName).validate_python("register_function_job"),
         function_job=function_job,
         user_id=user_id,
@@ -360,7 +369,7 @@ async def patch_registered_function_job(
     registered_function_job_patch: RegisteredFunctionJobPatch,
 ) -> RegisteredFunctionJob:
     result = await rabbitmq_rpc_client.request(
-        WEBSERVER_RPC_NAMESPACE,
+        DEFAULT_WEBSERVER_RPC_NAMESPACE,
         TypeAdapter(RPCMethodName).validate_python("patch_registered_function_job"),
         user_id=user_id,
         product_name=product_name,
@@ -382,7 +391,7 @@ async def get_function_job(
     product_name: ProductName,
 ) -> RegisteredFunctionJob:
     result = await rabbitmq_rpc_client.request(
-        WEBSERVER_RPC_NAMESPACE,
+        DEFAULT_WEBSERVER_RPC_NAMESPACE,
         TypeAdapter(RPCMethodName).validate_python("get_function_job"),
         function_job_id=function_job_id,
         user_id=user_id,
@@ -402,7 +411,7 @@ async def get_function_job_status(
     product_name: ProductName,
 ) -> FunctionJobStatus:
     result = await rabbitmq_rpc_client.request(
-        WEBSERVER_RPC_NAMESPACE,
+        DEFAULT_WEBSERVER_RPC_NAMESPACE,
         TypeAdapter(RPCMethodName).validate_python("get_function_job_status"),
         function_job_id=function_job_id,
         user_id=user_id,
@@ -421,7 +430,7 @@ async def get_function_job_outputs(
     product_name: ProductName,
 ) -> FunctionOutputs:
     result = await rabbitmq_rpc_client.request(
-        WEBSERVER_RPC_NAMESPACE,
+        DEFAULT_WEBSERVER_RPC_NAMESPACE,
         TypeAdapter(RPCMethodName).validate_python("get_function_job_outputs"),
         function_job_id=function_job_id,
         user_id=user_id,
@@ -442,7 +451,7 @@ async def update_function_job_status(
     check_write_permissions: bool = True,
 ) -> FunctionJobStatus:
     result = await rabbitmq_rpc_client.request(
-        WEBSERVER_RPC_NAMESPACE,
+        DEFAULT_WEBSERVER_RPC_NAMESPACE,
         TypeAdapter(RPCMethodName).validate_python("update_function_job_status"),
         function_job_id=function_job_id,
         job_status=job_status,
@@ -465,7 +474,7 @@ async def update_function_job_outputs(
     check_write_permissions: bool = True,
 ) -> FunctionOutputs:
     result = await rabbitmq_rpc_client.request(
-        WEBSERVER_RPC_NAMESPACE,
+        DEFAULT_WEBSERVER_RPC_NAMESPACE,
         TypeAdapter(RPCMethodName).validate_python("update_function_job_outputs"),
         function_job_id=function_job_id,
         outputs=outputs,
@@ -486,7 +495,7 @@ async def delete_function_job(
     function_job_id: FunctionJobID,
 ) -> None:
     result: None = await rabbitmq_rpc_client.request(
-        WEBSERVER_RPC_NAMESPACE,
+        DEFAULT_WEBSERVER_RPC_NAMESPACE,
         TypeAdapter(RPCMethodName).validate_python("delete_function_job"),
         function_job_id=function_job_id,
         user_id=user_id,
@@ -506,7 +515,7 @@ async def find_cached_function_jobs(
     inputs: FunctionInputs,
 ) -> list[RegisteredFunctionJob] | None:
     result = await rabbitmq_rpc_client.request(
-        WEBSERVER_RPC_NAMESPACE,
+        DEFAULT_WEBSERVER_RPC_NAMESPACE,
         TypeAdapter(RPCMethodName).validate_python("find_cached_function_jobs"),
         function_id=function_id,
         inputs=inputs,
@@ -528,7 +537,7 @@ async def register_function_job_collection(
     function_job_collection: FunctionJobCollection,
 ) -> RegisteredFunctionJobCollection:
     result = await rabbitmq_rpc_client.request(
-        WEBSERVER_RPC_NAMESPACE,
+        DEFAULT_WEBSERVER_RPC_NAMESPACE,
         TypeAdapter(RPCMethodName).validate_python("register_function_job_collection"),
         function_job_collection=function_job_collection,
         user_id=user_id,
@@ -547,7 +556,7 @@ async def get_function_job_collection(
     product_name: ProductName,
 ) -> RegisteredFunctionJobCollection:
     result = await rabbitmq_rpc_client.request(
-        WEBSERVER_RPC_NAMESPACE,
+        DEFAULT_WEBSERVER_RPC_NAMESPACE,
         TypeAdapter(RPCMethodName).validate_python("get_function_job_collection"),
         function_job_collection_id=function_job_collection_id,
         user_id=user_id,
@@ -566,7 +575,7 @@ async def delete_function_job_collection(
     function_job_collection_id: FunctionJobCollectionID,
 ) -> None:
     result = await rabbitmq_rpc_client.request(
-        WEBSERVER_RPC_NAMESPACE,
+        DEFAULT_WEBSERVER_RPC_NAMESPACE,
         TypeAdapter(RPCMethodName).validate_python("delete_function_job_collection"),
         function_job_collection_id=function_job_collection_id,
         user_id=user_id,
@@ -585,7 +594,7 @@ async def get_function_user_permissions(
     function_id: FunctionID,
 ) -> FunctionUserAccessRights:
     result = await rabbitmq_rpc_client.request(
-        WEBSERVER_RPC_NAMESPACE,
+        DEFAULT_WEBSERVER_RPC_NAMESPACE,
         TypeAdapter(RPCMethodName).validate_python("get_function_user_permissions"),
         function_id=function_id,
         user_id=user_id,
@@ -603,7 +612,7 @@ async def get_functions_user_api_access_rights(
     product_name: ProductName,
 ) -> FunctionUserApiAccessRights:
     result = await rabbitmq_rpc_client.request(
-        WEBSERVER_RPC_NAMESPACE,
+        DEFAULT_WEBSERVER_RPC_NAMESPACE,
         TypeAdapter(RPCMethodName).validate_python(
             "get_functions_user_api_access_rights"
         ),
@@ -632,7 +641,7 @@ async def set_group_permissions(
     ]
 ]:
     result = await rabbitmq_rpc_client.request(
-        WEBSERVER_RPC_NAMESPACE,
+        DEFAULT_WEBSERVER_RPC_NAMESPACE,
         TypeAdapter(RPCMethodName).validate_python("set_group_permissions"),
         user_id=user_id,
         product_name=product_name,