propagate name and description when creating program jobs

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,34 @@
         ],
         "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"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Name"
+          },
+          "description": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "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": {

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

@@ -4,11 +4,21 @@
 
 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 simcore_service_api_server.api.dependencies.authentication import (
+    get_current_user_id,
+    get_product_name,
+)
+from simcore_service_api_server.api.dependencies.webserver_rpc import (
+    get_wb_api_rpc_client,
+)
+from simcore_service_api_server.services_rpc.wb_api_server import WbApiRpcClient
 
 from .api.dependencies.webserver_http import get_webserver_session
 from .models.schemas.jobs import Job, JobInputs
@@ -26,11 +36,22 @@
 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,23 +62,34 @@ async def create_job(
         parent_node_id: NodeID | None,
         url_for: Callable[..., HttpUrl],
         hidden: bool,
+        name: str | None,
+        description: str | None,
     ) -> tuple[Job, ProjectGet]:
         # creates NEW job as prototype
         pre_job = Job.create_job_from_solver_or_program(
-            solver_or_program_name=solver_or_program.name, inputs=inputs
+            solver_or_program_name=solver_or_program.name, inputs=inputs, name=name
         )
         with log_context(
             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,
             )
             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/programs.py

@@ -2,7 +2,7 @@
 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,
@@ -81,11 +81,10 @@ 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, Body()] = None,
+    description: Annotated[str | None, 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 +96,16 @@ async def create_program_job(
     )
 
     job, project = await job_service.create_job(
+        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

@@ -116,7 +116,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(
+        name=None,
+        description=None,
         solver_or_program=solver,
         inputs=inputs,
         url_for=url_for,
@@ -125,12 +127,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

@@ -288,12 +288,15 @@ def _check_name(cls, v, info: ValidationInfo):
 
     @classmethod
     def create_now(
-        cls, parent_name: RelativeResourceName, inputs_checksum: str
+        cls,
+        parent_name: RelativeResourceName,
+        inputs_checksum: str,
+        name: str | None = None,
     ) -> "Job":
         global_uuid = uuid4()
 
         return cls(
-            name=cls.compose_resource_name(parent_name, global_uuid),
+            name=name or cls.compose_resource_name(parent_name, global_uuid),
             id=global_uuid,
             runner_name=parent_name,
             inputs_checksum=inputs_checksum,
@@ -305,9 +308,10 @@ def create_now(
 
     @classmethod
     def create_job_from_solver_or_program(
-        cls, *, solver_or_program_name: str, inputs: JobInputs
+        cls, *, solver_or_program_name: str, inputs: JobInputs, name: str | None = None
     ):
         return Job.create_now(
+            name=name,
             parent_name=solver_or_program_name,
             inputs_checksum=inputs.compute_checksum(),
         )

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

@@ -119,7 +119,11 @@ def get_node_id(project_id, solver_id) -> str:
 
 
 def create_new_project_for_job(
-    solver_or_program: Solver | Program, job: Job, inputs: JobInputs
+    *,
+    solver_or_program: Solver | Program,
+    job: Job,
+    inputs: JobInputs,
+    description: str | None = None,
 ) -> ProjectCreateNew:
     """
     Creates a project for a solver's job
@@ -159,7 +163,8 @@ def create_new_project_for_job(
     return ProjectCreateNew(
         uuid=project_id,
         name=job.name,  # NOTE: this IS an identifier as well. MUST NOT be changed in the case of project APIs!
-        description=f"Study associated to solver job:\n{job_info}",
+        description=description
+        or f"Study associated to solver/study/program job:\n{job_info}",
         thumbnail="https://via.placeholder.com/170x120.png",  # type: ignore[arg-type]
         workbench={solver_id: solver_service},
         ui=StudyUI(