server-client rpc interface

Author: pcrespov

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

@@ -1,27 +1,38 @@
 import logging
 
+from models_library.api_schemas_webserver import WEBSERVER_RPC_NAMESPACE
+from models_library.products import ProductName
 from models_library.projects import ProjectID
-from pydantic import TypeAdapter
+from models_library.rabbitmq_basic_types import RPCMethodName
+from models_library.users import UserID
+from pydantic import TypeAdapter, validate_call
 from servicelib.logging_utils import log_decorator
 from servicelib.rabbitmq import RabbitMQRPCClient
 
 _logger = logging.getLogger(__name__)
 
 
 @log_decorator(_logger, level=logging.DEBUG)
+@validate_call(config={"arbitrary_types_allowed": True})
 async def mark_project_as_job(
     rpc_client: RabbitMQRPCClient,
     *,
+    product_name: ProductName,
+    user_id: UserID,
     project_uuid: ProjectID,
     job_parent_resource_name: str,
 ) -> None:
 
-    assert rpc_client
-
     assert not job_parent_resource_name.startswith("/")  # nosec
     assert "/" in job_parent_resource_name  # nosec
     assert not job_parent_resource_name.endswith("/")  # nosec
 
-    TypeAdapter(ProjectID).validate_python(project_uuid)
-
-    raise NotImplementedError
+    result = await rpc_client.request(
+        WEBSERVER_RPC_NAMESPACE,
+        TypeAdapter(RPCMethodName).validate_python("mark_project_as_job"),
+        product_name=product_name,
+        user_id=user_id,
+        project_uuid=project_uuid,
+        job_parent_resource_name=job_parent_resource_name,
+    )
+    assert result is None

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

@@ -0,0 +1,33 @@
+from aiohttp import web
+from models_library.api_schemas_webserver import WEBSERVER_RPC_NAMESPACE
+from models_library.products import ProductName
+from models_library.projects import ProjectID
+from models_library.users import UserID
+from pydantic import validate_call
+from servicelib.rabbitmq import RPCRouter
+
+from ...rabbitmq import get_rabbitmq_rpc_server
+
+router = RPCRouter()
+
+
+@router.expose()
+@validate_call(config={"arbitrary_types_allowed": True})
+async def mark_project_as_job(
+    app: web.Application,
+    *,
+    product_name: ProductName,
+    user_id: UserID,
+    project_uuid: ProjectID,
+    job_parent_resource_name: str,
+) -> None:
+    msg = (
+        f"You have reached {__name__} but this feature is still not implemented. "
+        f"Inputs: {app=}, {product_name=}, {user_id=}, {project_uuid=}, {job_parent_resource_name=}"
+    )
+    raise NotImplementedError(msg)
+
+
+async def register_rpc_routes_on_startup(app: web.Application):
+    rpc_server = get_rabbitmq_rpc_server(app)
+    await rpc_server.register_router(router, WEBSERVER_RPC_NAMESPACE, app)

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

@@ -19,13 +19,14 @@
     nodes_rest,
     ports_rest,
     projects_rest,
+    projects_rpc,
+    projects_slot,
     projects_states_rest,
     tags_rest,
     trash_rest,
     wallets_rest,
     workspaces_rest,
 )
-from ._controller.projects_slot import setup_project_observer_events
 from ._projects_repository_legacy import setup_projects_db
 from ._security_service import setup_projects_access
 
@@ -48,9 +49,13 @@ def setup_projects(app: web.Application) -> bool:
     # database API
     setup_projects_db(app)
 
-    # registers event handlers (e.g. on_user_disconnect)
-    setup_project_observer_events(app)
+    # setup SLOT-controllers
+    projects_slot.setup_project_observer_events(app)
 
+    # setup RPC-controllers
+    app.on_startup.append(projects_rpc.register_rpc_routes_on_startup)
+
+    # setup REST-controllers
     app.router.add_routes(projects_states_rest.routes)
     app.router.add_routes(projects_rest.routes)
     app.router.add_routes(comments_rest.routes)

services/web/server/tests/unit/with_dbs/02/test_projects_rpc.py

@@ -0,0 +1,120 @@
+# pylint: disable=redefined-outer-name
+# pylint: disable=unused-argument
+# pylint: disable=unused-variable
+# pylint: disable=too-many-arguments
+
+
+from collections.abc import AsyncIterator, Awaitable, Callable
+from uuid import UUID
+
+import pytest
+from aiohttp.test_utils import TestClient
+from common_library.users_enums import UserRole
+from models_library.products import ProductName
+from models_library.projects import ProjectID
+from pytest_simcore.helpers.monkeypatch_envs import setenvs_from_dict
+from pytest_simcore.helpers.typing_env import EnvVarsDict
+from pytest_simcore.helpers.webserver_login import NewUser, UserInfoDict
+from servicelib.rabbitmq import RabbitMQRPCClient
+from servicelib.rabbitmq.rpc_interfaces.webserver import projects as projects_rpc
+from settings_library.rabbit import RabbitSettings
+from simcore_service_webserver.application_settings import ApplicationSettings
+from simcore_service_webserver.projects.models import ProjectDict
+
+pytest_simcore_core_services_selection = [
+    "rabbit",
+]
+
+
+@pytest.fixture
+def user_role() -> UserRole:
+    # for logged_user
+    return UserRole.USER
+
+
+@pytest.fixture
+def app_environment(
+    rabbit_service: RabbitSettings,
+    app_environment: EnvVarsDict,
+    monkeypatch: pytest.MonkeyPatch,
+):
+    new_envs = setenvs_from_dict(
+        monkeypatch,
+        {
+            **app_environment,
+            "RABBIT_HOST": rabbit_service.RABBIT_HOST,
+            "RABBIT_PORT": f"{rabbit_service.RABBIT_PORT}",
+            "RABBIT_USER": rabbit_service.RABBIT_USER,
+            "RABBIT_SECURE": f"{rabbit_service.RABBIT_SECURE}",
+            "RABBIT_PASSWORD": rabbit_service.RABBIT_PASSWORD.get_secret_value(),
+        },
+    )
+
+    settings = ApplicationSettings.create_from_envs()
+    assert settings.WEBSERVER_RABBITMQ
+
+    return new_envs
+
+
+@pytest.fixture
+async def rpc_client(
+    rabbitmq_rpc_client: Callable[[str], Awaitable[RabbitMQRPCClient]],
+) -> RabbitMQRPCClient:
+    return await rabbitmq_rpc_client("client")
+
+
+@pytest.fixture
+async def other_user(
+    client: TestClient,
+    logged_user: UserInfoDict,
+) -> AsyncIterator[UserInfoDict]:
+
+    async with NewUser(
+        user_data={
+            "name": "other-user",
+            "email": "other-user" + logged_user["email"],
+        },
+        app=client.app,
+    ) as other_user_info:
+
+        assert other_user_info["name"] != logged_user["name"]
+        yield other_user_info
+
+
+async def test_rpc_client_mark_project_as_job(
+    rpc_client: RabbitMQRPCClient,
+    product_name: ProductName,
+    logged_user: UserInfoDict,
+    other_user: UserInfoDict,
+    user_project: ProjectDict,
+):
+    # `logged_user` OWNS the `user_project` but not `other_user`
+    project_uuid: ProjectID = UUID(user_project["uuid"])
+    user_id = logged_user["id"]
+    other_user_id = other_user["id"]
+
+    await projects_rpc.mark_project_as_job(
+        rpc_client=rpc_client,
+        product_name=product_name,
+        user_id=user_id,
+        project_uuid=project_uuid,
+        job_parent_resource_name="solvers/solver123/version/1.2.3",
+    )
+
+    with pytest.raises(Exception, match="no access"):
+        await projects_rpc.mark_project_as_job(
+            rpc_client=rpc_client,
+            product_name=product_name,
+            user_id=other_user_id,  # <-- no access
+            project_uuid=project_uuid,
+            job_parent_resource_name="solvers/solver123/version/1.2.3",
+        )
+
+    with pytest.raises(Exception, match="not found"):
+        await projects_rpc.mark_project_as_job(
+            rpc_client=rpc_client,
+            product_name=product_name,
+            user_id=logged_user["id"],
+            project_uuid=UUID("00000000-0000-0000-0000-000000000000"),  # <-- wont find
+            job_parent_resource_name="solvers/solver123/version/1.2.3",
+        )