🎨 Program jobs: Pass metadata and return display version (#7562)

Author: bisgaard-itis

services/api-server/openapi.json

@@ -1321,7 +1321,7 @@
           "programs"
         ],
         "summary": "Create Program Job",
-        "description": "Creates a job in a specific release with given inputs.\n\nNOTE: This operation does **not** start the job",
+        "description": "Creates a program job",
         "operationId": "create_program_job",
         "security": [
           {
@@ -1384,6 +1384,15 @@
             }
           }
         ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/Body_create_program_job_v0_programs__program_key__releases__version__jobs_post"
+              }
+            }
+          }
+        },
         "responses": {
           "201": {
             "description": "Successful Response",
@@ -6056,6 +6065,36 @@
         ],
         "title": "Body_complete_multipart_upload_v0_files__file_id__complete_post"
       },
+      "Body_create_program_job_v0_programs__program_key__releases__version__jobs_post": {
+        "properties": {
+          "name": {
+            "anyOf": [
+              {
+                "type": "string",
+                "maxLength": 500
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Name"
+          },
+          "description": {
+            "anyOf": [
+              {
+                "type": "string",
+                "maxLength": 500
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Description"
+          }
+        },
+        "type": "object",
+        "title": "Body_create_program_job_v0_programs__program_key__releases__version__jobs_post"
+      },
       "Body_upload_file_v0_files_content_put": {
         "properties": {
           "file": {
@@ -7715,14 +7754,26 @@
             ],
             "title": "Url",
             "description": "Link to get this resource"
+          },
+          "version_display": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Version Display"
           }
         },
         "type": "object",
         "required": [
           "id",
           "version",
           "title",
-          "url"
+          "url",
+          "version_display"
         ],
         "title": "Program",
         "description": "A released program with a specific version",
@@ -7732,7 +7783,8 @@
           "maintainer": "info@itis.swiss",
           "title": "Sim4life",
           "url": "https://api.osparc.io/v0/solvers/simcore%2Fservices%2Fdynamic%2Fsim4life/releases/8.0.0",
-          "version": "8.0.0"
+          "version": "8.0.0",
+          "version_display": "8.0.0"
         }
       },
       "RunningState": {

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

@@ -4,13 +4,22 @@
 
 from fastapi import Depends
 from models_library.api_schemas_webserver.projects import ProjectCreateNew, ProjectGet
+from models_library.products import ProductName
 from models_library.projects import ProjectID
 from models_library.projects_nodes_io import NodeID
+from models_library.users import UserID
 from pydantic import HttpUrl
 from servicelib.fastapi.app_state import SingletonInAppStateMixin
 from servicelib.logging_utils import log_context
 
+from .api.dependencies.authentication import (
+    get_current_user_id,
+    get_product_name,
+)
 from .api.dependencies.webserver_http import get_webserver_session
+from .api.dependencies.webserver_rpc import (
+    get_wb_api_rpc_client,
+)
 from .models.schemas.jobs import Job, JobInputs
 from .models.schemas.programs import Program
 from .models.schemas.solvers import Solver
@@ -19,18 +28,30 @@
     create_new_project_for_job,
 )
 from .services_http.webserver import AuthSession
+from .services_rpc.wb_api_server import WbApiRpcClient
 
 _logger = logging.getLogger(__name__)
 
 
 class JobService(SingletonInAppStateMixin):
     app_state_name = "JobService"
     _web_rest_api: AuthSession
+    _web_rpc_api: WbApiRpcClient
+    _user_id: UserID
+    _product_name: ProductName
 
     def __init__(
-        self, web_rest_api: Annotated[AuthSession, Depends(get_webserver_session)]
+        self,
+        *,
+        web_rest_api: Annotated[AuthSession, Depends(get_webserver_session)],
+        web_rpc_api: Annotated[WbApiRpcClient, Depends(get_wb_api_rpc_client)],
+        user_id: Annotated[UserID, Depends(get_current_user_id)],
+        product_name: Annotated[ProductName, Depends(get_product_name)],
     ):
         self._web_rest_api = web_rest_api
+        self._web_rpc_api = web_rpc_api
+        self._user_id = user_id
+        self._product_name = product_name
 
     async def create_job(
         self,
@@ -41,7 +62,10 @@ async def create_job(
         parent_node_id: NodeID | None,
         url_for: Callable[..., HttpUrl],
         hidden: bool,
+        project_name: str | None,
+        description: str | None,
     ) -> tuple[Job, ProjectGet]:
+        """If no project_name is provided, the job name is used as project name."""
         # creates NEW job as prototype
         pre_job = Job.create_job_from_solver_or_program(
             solver_or_program_name=solver_or_program.name, inputs=inputs
@@ -50,14 +74,24 @@ async def create_job(
             logger=_logger, level=logging.DEBUG, msg=f"Creating job {pre_job.name}"
         ):
             project_in: ProjectCreateNew = create_new_project_for_job(
-                solver_or_program, pre_job, inputs
+                solver_or_program=solver_or_program,
+                job=pre_job,
+                inputs=inputs,
+                description=description,
+                project_name=project_name,
             )
             new_project: ProjectGet = await self._web_rest_api.create_project(
                 project_in,
                 is_hidden=hidden,
                 parent_project_uuid=parent_project_uuid,
                 parent_node_id=parent_node_id,
             )
+            await self._web_rpc_api.mark_project_as_job(
+                product_name=self._product_name,
+                user_id=self._user_id,
+                project_uuid=new_project.uuid,
+                job_parent_resource_name=pre_job.runner_name,
+            )
 
         assert new_project  # nosec
         assert new_project.uuid == pre_job.id  # nosec

services/api-server/src/simcore_service_api_server/api/routes/_constants.py

@@ -26,6 +26,8 @@
     "Please use `{}` instead.\n\n"
 )
 
+DEFAULT_MAX_STRING_LENGTH: Final[int] = 500
+
 
 def create_route_description(
     *,

services/api-server/src/simcore_service_api_server/api/routes/programs.py

@@ -1,15 +1,16 @@
+# pylint: disable=too-many-arguments
 import logging
 from collections.abc import Callable
 from typing import Annotated
 
-from fastapi import APIRouter, Depends, Header, HTTPException, status
+from fastapi import APIRouter, Body, Depends, Header, HTTPException, status
 from httpx import HTTPStatusError
 from models_library.api_schemas_storage.storage_schemas import (
     LinkType,
 )
 from models_library.projects import ProjectID
 from models_library.projects_nodes_io import NodeID
-from pydantic import ByteSize, PositiveInt, ValidationError
+from pydantic import ByteSize, PositiveInt, StringConstraints, ValidationError
 from servicelib.fastapi.dependencies import get_reverse_url_mapper
 from simcore_sdk.node_ports_common.constants import SIMCORE_LOCATION
 from simcore_sdk.node_ports_common.filemanager import (
@@ -19,6 +20,7 @@
 
 from ..._service_job import JobService
 from ..._service_programs import ProgramService
+from ...api.routes._constants import DEFAULT_MAX_STRING_LENGTH
 from ...models.basic_types import VersionStr
 from ...models.schemas.jobs import Job, JobInputs
 from ...models.schemas.programs import Program, ProgramKeyId
@@ -81,11 +83,14 @@ async def create_program_job(
     product_name: Annotated[str, Depends(get_product_name)],
     x_simcore_parent_project_uuid: Annotated[ProjectID | None, Header()] = None,
     x_simcore_parent_node_id: Annotated[NodeID | None, Header()] = None,
+    name: Annotated[
+        str | None, StringConstraints(max_length=DEFAULT_MAX_STRING_LENGTH), Body()
+    ] = None,
+    description: Annotated[
+        str | None, StringConstraints(max_length=DEFAULT_MAX_STRING_LENGTH), Body()
+    ] = None,
 ):
-    """Creates a job in a specific release with given inputs.
-
-    NOTE: This operation does **not** start the job
-    """
+    """Creates a program job"""
 
     # ensures user has access to solver
     inputs = JobInputs(values={})
@@ -97,13 +102,16 @@ async def create_program_job(
     )
 
     job, project = await job_service.create_job(
+        project_name=name,
+        description=description,
         solver_or_program=program,
         inputs=inputs,
         parent_project_uuid=x_simcore_parent_project_uuid,
         parent_node_id=x_simcore_parent_node_id,
         url_for=url_for,
         hidden=False,
     )
+
     # create workspace directory so files can be uploaded to it
     assert len(project.workbench) > 0  # nosec
     node_id = next(iter(project.workbench))

services/api-server/src/simcore_service_api_server/api/routes/solvers_jobs.py

@@ -32,14 +32,10 @@
 from ...services_http.solver_job_models_converters import (
     create_jobstatus_from_task,
 )
-from ...services_rpc.wb_api_server import WbApiRpcClient
 from ..dependencies.application import get_reverse_url_mapper
 from ..dependencies.authentication import get_current_user_id, get_product_name
 from ..dependencies.services import get_api_client
 from ..dependencies.webserver_http import AuthSession, get_webserver_session
-from ..dependencies.webserver_rpc import (
-    get_wb_api_rpc_client,
-)
 from ._constants import (
     FMSG_CHANGELOG_ADDED_IN_VERSION,
     FMSG_CHANGELOG_CHANGED_IN_VERSION,
@@ -97,7 +93,6 @@ async def create_solver_job(
     user_id: Annotated[PositiveInt, Depends(get_current_user_id)],
     solver_service: Annotated[SolverService, Depends()],
     job_service: Annotated[JobService, Depends()],
-    wb_api_rpc: Annotated[WbApiRpcClient, Depends(get_wb_api_rpc_client)],
     url_for: Annotated[Callable, Depends(get_reverse_url_mapper)],
     product_name: Annotated[str, Depends(get_product_name)],
     hidden: Annotated[bool, Query()] = True,
@@ -116,7 +111,9 @@ async def create_solver_job(
         version=version,
         product_name=product_name,
     )
-    job, project = await job_service.create_job(
+    job, _ = await job_service.create_job(
+        project_name=None,
+        description=None,
         solver_or_program=solver,
         inputs=inputs,
         url_for=url_for,
@@ -125,12 +122,6 @@ async def create_solver_job(
         parent_node_id=x_simcore_parent_node_id,
     )
 
-    await wb_api_rpc.mark_project_as_job(
-        product_name=product_name,
-        user_id=user_id,
-        project_uuid=project.uuid,
-        job_parent_resource_name=job.runner_name,
-    )
     return job
 
 

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

@@ -24,8 +24,6 @@
     StringConstraints,
     TypeAdapter,
     ValidationError,
-    ValidationInfo,
-    field_validator,
 )
 from servicelib.logging_utils import LogLevelInt, LogMessageStr
 from starlette.datastructures import Headers
@@ -275,20 +273,13 @@ class Job(BaseModel):
         }
     )
 
-    @field_validator("name", mode="before")
-    @classmethod
-    def _check_name(cls, v, info: ValidationInfo):
-        _id = str(info.data["id"])
-        if not v.endswith(f"/{_id}"):
-            msg = f"Resource name [{v}] and id [{_id}] do not match"
-            raise ValueError(msg)
-        return v
-
     # constructors ------
 
     @classmethod
     def create_now(
-        cls, parent_name: RelativeResourceName, inputs_checksum: str
+        cls,
+        parent_name: RelativeResourceName,
+        inputs_checksum: str,
     ) -> "Job":
         global_uuid = uuid4()