✨ Refactor project-related models and RPCs for consistency and clarity

- Rename ProjectRpcGet to ProjectJobRpcGet
- Update job-related models to include workbench and job_parent_resource_name
- Adjust job creation logic to use updated models
- Modify tests to reflect model changes

Author: pcrespov

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

@@ -1,13 +1,13 @@
 from datetime import datetime
 from typing import Annotated, TypeAlias
 
-from models_library.projects import ProjectID
+from models_library.projects import NodesDict, ProjectID
 from models_library.rpc_pagination import PageRpc
 from pydantic import BaseModel, ConfigDict, Field
 from pydantic.types import JsonDict
 
 
-class ProjectRpcGet(BaseModel):
+class ProjectJobRpcGet(BaseModel):
     """
     Minimal information about a project that (for now) will fullfill
     the needs of the api-server. Specifically, the fields needed in
@@ -24,10 +24,14 @@ class ProjectRpcGet(BaseModel):
     ]
     description: str
 
+    workbench: NodesDict
+
     # timestamps
     creation_date: datetime
     last_change_date: datetime
 
+    job_parent_resource_name: str
+
     @staticmethod
     def _update_json_schema_extra(schema: JsonDict) -> None:
         schema.udpate(
@@ -39,6 +43,8 @@ def _update_json_schema_extra(schema: JsonDict) -> None:
                         "description": "My project description",
                         "creation_date": "2023-01-01T00:00:00Z",
                         "last_change_date": "2023-01-01T00:00:00Z",
+                        "job_parent_resource_name": "solvers/foo/release/1.2.3",
+                        "workbench": {},
                     },
                 ]
             }
@@ -55,5 +61,5 @@ def _update_json_schema_extra(schema: JsonDict) -> None:
     # 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
+    ProjectJobRpcGet
 ]

services/api-server/src/simcore_service_api_server/_service_solvers.py

@@ -4,6 +4,7 @@
 from fastapi import Depends
 from models_library.basic_types import VersionStr
 from models_library.products import ProductName
+from models_library.projects_nodes import Node
 from models_library.rest_pagination import (
     MAXIMUM_NUMBER_OF_ITEMS_PER_PAGE,
     PageMetaInfoLimitOffset,
@@ -16,8 +17,9 @@
 from packaging.version import Version
 
 from .api.dependencies.webserver_rpc import get_wb_api_rpc_client
-from .models.schemas.jobs import Job
+from .models.schemas.jobs import JobInputs, JobModel
 from .models.schemas.solvers import Solver, SolverKeyId
+from .models.solver_job_models_converters import create_job_inputs_from_node_inputs
 from .services_rpc.catalog import CatalogService
 from .services_rpc.wb_api_server import WbApiRpcClient
 
@@ -93,7 +95,7 @@ async def list_jobs(
         product_name: ProductName,
         offset: PageOffsetInt = 0,
         limit: PageLimitInt = DEFAULT_PAGINATION_LIMIT,
-    ) -> tuple[list[Job], PageMetaInfoLimitOffset]:
+    ) -> tuple[list[JobModel], PageMetaInfoLimitOffset]:
         """Lists all solver jobs for a user with pagination"""
 
         # NOTE: perhaps we should get comp_tasks instead of projects! or a combinatino of both?
@@ -107,18 +109,28 @@ async def list_jobs(
             job_parent_resource_name_filter="solvers",  # TODO: project shouldr eturn parent resource name and workbench
         )
 
-        solver = None  # TODO
-        url_for = None  # TODO
-
-        jobs: list[Job] = [
-            Job(
-                id=prj.uuid,
-                name=prj.name,
-                inputs_checksum=prj.inputs_checksum,
-                created_at=prj.creation_date,  # type: ignore[arg-type]
-                runner_name=prj.job_parent_resource_name,
-                # TODO: url_ parts missing
+        jobs: list[JobModel] = []
+
+        for prj in projects_page.data:
+
+            assert len(prj.workbench) == 1, "Expected only one solver node in workbench"
+
+            solver_node: Node = next(iter(prj.workbench.values()))
+            job_inputs: JobInputs = create_job_inputs_from_node_inputs(
+                inputs=solver_node.inputs or {}
             )
-            for prj in projects_page.data
-        ]
+            assert prj.job_parent_resource_name  # nosec
+
+            jobs.append(
+                JobModel(
+                    id=prj.uuid,
+                    name=JobModel.compose_resource_name(
+                        prj.job_parent_resource_name, prj.uuid
+                    ),
+                    inputs_checksum=job_inputs.compute_checksum(),
+                    created_at=prj.creation_date,
+                    runner_name=prj.job_parent_resource_name,
+                )
+            )
+
         return jobs, projects_page.meta

services/api-server/src/simcore_service_api_server/models/schemas/jobs.py

@@ -27,6 +27,7 @@
     ValidationInfo,
     field_validator,
 )
+from pydantic.types import JsonDict
 from servicelib.logging_utils import LogLevelInt, LogMessageStr
 from starlette.datastructures import Headers
 
@@ -237,7 +238,7 @@ class JobMetadata(BaseModel):
 #     "jobs/c2789bd2-7385-4e00-91d3-2f100df41185"
 
 
-class Job(BaseModel):
+class JobModel(BaseModel):
     id: JobID
     name: RelativeResourceName
 
@@ -249,6 +250,41 @@ class Job(BaseModel):
         ..., description="Runner that executes job"
     )
 
+    @staticmethod
+    def _update_json_schema_extra(schema: JsonDict) -> None:
+        schema.udpate(
+            {
+                "examples": [
+                    {
+                        "id": "f622946d-fd29-35b9-a193-abdd1095167c",
+                        "name": "solvers/isolve/releases/1.3.4/jobs/f622946d-fd29-35b9-a193-abdd1095167c",
+                        "runner_name": "solvers/isolve/releases/1.3.4",
+                        "inputs_checksum": "12345",
+                        "created_at": "2021-01-22T23:59:52.322176",
+                    },
+                ]
+            }
+        )
+
+    model_config = ConfigDict(
+        json_schema_extra=_update_json_schema_extra,
+    )
+
+    @staticmethod
+    def compose_resource_name(
+        parent_name: RelativeResourceName, job_id: UUID
+    ) -> RelativeResourceName:
+        # CAREFUL, this is not guarantee a UNIQUE identifier since the resource
+        # could have some alias entrypoints and the wrong parent_name might be introduced here
+        collection_or_resource_ids = [
+            *split_resource_name(parent_name),
+            "jobs",
+            f"{job_id}",
+        ]
+        return compose_resource_name(*collection_or_resource_ids)
+
+
+class Job(JobModel):
     # Get links to other resources
     url: Annotated[HttpUrl, UriSchema()] | None = Field(
         ..., description="Link to get this resource (self)"
@@ -284,6 +320,11 @@ def _check_name(cls, v, info: ValidationInfo):
             raise ValueError(msg)
         return v
 
+    @property
+    def resource_name(self) -> str:
+        """Relative Resource Name"""
+        return self.name
+
     # constructors ------
 
     @classmethod
@@ -312,24 +353,6 @@ def create_job_from_solver_or_program(
             inputs_checksum=inputs.compute_checksum(),
         )
 
-    @classmethod
-    def compose_resource_name(
-        cls, parent_name: RelativeResourceName, job_id: UUID
-    ) -> RelativeResourceName:
-        # CAREFUL, this is not guarantee a UNIQUE identifier since the resource
-        # could have some alias entrypoints and the wrong parent_name might be introduced here
-        collection_or_resource_ids = [
-            *split_resource_name(parent_name),
-            "jobs",
-            f"{job_id}",
-        ]
-        return compose_resource_name(*collection_or_resource_ids)
-
-    @property
-    def resource_name(self) -> str:
-        """Relative Resource Name"""
-        return self.name
-
 
 def get_url(
     solver_or_program: Solver | Program, url_for: Callable[..., HttpUrl], job_id: JobID

services/api-server/src/simcore_service_api_server/models/solver_job_models_converters.py

@@ -15,7 +15,6 @@
 from models_library.basic_types import KeyIDStr
 from models_library.projects import Project
 from models_library.projects_nodes import InputID
-from models_library.rpc.webserver.projects import ProjectRpcGet
 from pydantic import HttpUrl, TypeAdapter
 
 from ..services_http.director_v2 import ComputationTaskGet
@@ -183,7 +182,7 @@ def create_new_project_for_job(
 def create_job_from_project(
     *,
     solver_or_program: Solver | Program,
-    project: ProjectRpcGet | ProjectGet | Project,
+    project: ProjectGet | Project,
     url_for: Callable[..., HttpUrl],
 ) -> Job:
     """
@@ -198,9 +197,7 @@ def create_job_from_project(
     assert solver_or_program.version in project.name  # nosec
     assert urllib.parse.quote_plus(solver_or_program.id) in project.name  # nosec
 
-    # get solver node
-    node_id = next(iter(project.workbench.keys()))
-    solver_node: Node = project.workbench[node_id]
+    solver_node: Node = next(iter(project.workbench.values()))
     job_inputs: JobInputs = create_job_inputs_from_node_inputs(
         inputs=solver_node.inputs or {}
     )
@@ -210,7 +207,7 @@ def create_job_from_project(
 
     job_id = project.uuid
 
-    job = Job(
+    return Job(
         id=job_id,
         name=project.name,
         inputs_checksum=job_inputs.compute_checksum(),
@@ -225,8 +222,6 @@ def create_job_from_project(
         ),
     )
 
-    return job
-
 
 def create_jobstatus_from_task(task: ComputationTaskGet) -> JobStatus:
     return JobStatus(

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

@@ -3,7 +3,7 @@
 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.rpc.webserver.projects import PageRpcProjectRpcGet, ProjectJobRpcGet
 from models_library.users import UserID
 from pydantic import ValidationError, validate_call
 from servicelib.rabbitmq import RPCRouter
@@ -76,12 +76,14 @@ async def list_projects_marked_as_jobs(
     )
 
     job_projects = [
-        ProjectRpcGet(
+        ProjectJobRpcGet(
             uuid=project.uuid,
             name=project.name,
             description=project.description,
+            workbench={},  # FIXME: this should be extracted
             creation_date=project.creation_date,
             last_change_date=project.last_change_date,
+            job_parent_resource_name=project.job_parent_resource_name,
         )
         for project in projects
     ]

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

@@ -12,7 +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 models_library.rpc.webserver.projects import PageRpcProjectRpcGet, ProjectJobRpcGet
 from pydantic import ValidationError
 from pytest_simcore.helpers.monkeypatch_envs import setenvs_from_dict
 from pytest_simcore.helpers.typing_env import EnvVarsDict
@@ -116,7 +116,7 @@ async def test_rpc_client_list_my_projects_marked_as_jobs(
 
     assert page.meta.total == 1
     assert page.meta.offset == 0
-    assert isinstance(page.data[0], ProjectRpcGet)
+    assert isinstance(page.data[0], ProjectJobRpcGet)
     assert page.data[0].uuid == project_uuid