drafts rpc

Author: pcrespov

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

@@ -0,0 +1,37 @@
+from datetime import datetime
+from typing import Annotated, TypeAlias
+
+from models_library.projects import NodesDict, ProjectID
+from models_library.rpc_pagination import PageRpc
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class ProjectRpcGet(BaseModel):
+    uuid: Annotated[
+        ProjectID,
+        Field(description="project unique identifier"),
+    ]
+    name: Annotated[
+        str,
+        Field(description="project display name"),
+    ]
+    description: str
+
+    # timestamps
+    creation_date: datetime
+    last_change_date: datetime
+
+    workbench: Annotated[NodesDict, Field(description="Project's pipeline")]
+
+    model_config = ConfigDict(
+        extra="forbid",
+        populate_by_name=True,
+    )
+
+
+PageRpcProjectRpcGet: TypeAlias = PageRpc[
+    # WARNING: keep this definition in models_library and not in the RPC interface
+    # otherwise the metaclass PageRpc[*] will create *different* classes in server/client side
+    # and will fail to serialize/deserialize these parameters when transmitted/received
+    ProjectRpcGet
+]

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

@@ -4,6 +4,12 @@
 from models_library.products import ProductName
 from models_library.projects import ProjectID
 from models_library.rabbitmq_basic_types import RPCMethodName
+from models_library.rest_pagination import PageOffsetInt
+from models_library.rpc.webserver.projects import PageRpcProjectRpcGet
+from models_library.rpc_pagination import (
+    DEFAULT_NUMBER_OF_ITEMS_PER_PAGE,
+    PageLimitInt,
+)
 from models_library.users import UserID
 from pydantic import TypeAdapter, validate_call
 from servicelib.logging_utils import log_decorator
@@ -32,3 +38,29 @@ async def mark_project_as_job(
         job_parent_resource_name=job_parent_resource_name,
     )
     assert result is None
+
+
+@log_decorator(_logger, level=logging.DEBUG)
+@validate_call(config={"arbitrary_types_allowed": True})
+async def list_my_projects_marked_as_jobs(
+    rpc_client: RabbitMQRPCClient,
+    *,
+    product_name: ProductName,
+    user_id: UserID,
+    # pagination
+    offset: PageOffsetInt = 0,
+    limit: PageLimitInt = DEFAULT_NUMBER_OF_ITEMS_PER_PAGE,
+    # filters
+    job_parent_resource_name_filter: str | None = None,
+) -> PageRpcProjectRpcGet:
+    result = await rpc_client.request(
+        WEBSERVER_RPC_NAMESPACE,
+        TypeAdapter(RPCMethodName).validate_python("list_my_projects_marked_as_jobs"),
+        product_name=product_name,
+        user_id=user_id,
+        offset=offset,
+        limit=limit,
+        job_parent_resource_name_filter=job_parent_resource_name_filter,
+    )
+    assert TypeAdapter(PageRpcProjectRpcGet).validate_python(result)  # nosec
+    return result

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

@@ -2,6 +2,8 @@
 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.rest_pagination import PageLimitInt, PageOffsetInt
+from models_library.rpc.webserver.projects import PageRpcProjectRpcGet, ProjectRpcGet
 from models_library.users import UserID
 from pydantic import ValidationError, validate_call
 from servicelib.rabbitmq import RPCRouter
@@ -50,6 +52,51 @@ async def mark_project_as_job(
         raise ProjectNotFoundRpcError.from_domain_error(err) from err
 
 
+@router.expose(reraise_if_error_type=(ValidationError,))
+@validate_call(config={"arbitrary_types_allowed": True})
+async def list_my_projects_marked_as_jobs(
+    app: web.Application,
+    *,
+    product_name: ProductName,
+    user_id: UserID,
+    # pagination
+    offset: PageOffsetInt,
+    limit: PageLimitInt,
+    # filters
+    job_parent_resource_name_filter: str | None,
+) -> PageRpcProjectRpcGet:
+
+    total, projects = await _jobs_service.list_my_projects_marked_as_jobs(
+        app,
+        product_name=product_name,
+        user_id=user_id,
+        offset=offset,
+        limit=limit,
+        job_parent_resource_name_filter=job_parent_resource_name_filter,
+    )
+
+    job_projects = [
+        ProjectRpcGet(
+            uuid=project.uuid,
+            name=project.name,
+            description=project.description,
+            creation_date=project.creation_date,
+            last_change_date=project.last_change_date,
+            workbench={},
+        )
+        for project in projects
+    ]
+
+    page: PageRpcProjectRpcGet = PageRpcProjectRpcGet.create(
+        job_projects,
+        total=total,
+        limit=limit,
+        offset=offset,
+    )
+
+    return page
+
+
 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/tests/unit/with_dbs/02/test_projects_rpc.py

@@ -12,6 +12,7 @@
 from common_library.users_enums import UserRole
 from models_library.products import ProductName
 from models_library.projects import ProjectID
+from models_library.rpc.webserver.projects import PageRpcProjectRpcGet, ProjectRpcGet
 from pydantic import ValidationError
 from pytest_simcore.helpers.monkeypatch_envs import setenvs_from_dict
 from pytest_simcore.helpers.typing_env import EnvVarsDict
@@ -87,6 +88,38 @@ async def test_rpc_client_mark_project_as_job(
     )
 
 
+async def test_rpc_client_list_my_projects_marked_as_jobs(
+    rpc_client: RabbitMQRPCClient,
+    product_name: ProductName,
+    logged_user: UserInfoDict,
+    user_project: ProjectDict,
+):
+    project_uuid = ProjectID(user_project["uuid"])
+    user_id = logged_user["id"]
+
+    # Mark the project as a job first
+    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",
+    )
+
+    # List projects marked as jobs
+    page: PageRpcProjectRpcGet = await projects_rpc.list_my_projects_marked_as_jobs(
+        rpc_client=rpc_client,
+        product_name=product_name,
+        user_id=user_id,
+        job_parent_resource_name_filter="solvers/solver123",
+    )
+
+    assert page.meta.total == 1
+    assert page.meta.offset == 0
+    assert isinstance(page.data[0], ProjectRpcGet)
+    assert page.data[0].uuid == project_uuid
+
+
 @pytest.fixture
 async def other_user(
     client: TestClient,