JobRestInterfaceLinks -> JobInterfaceLinks

Author: bisgaard-itis

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

@@ -257,7 +257,7 @@ async def run_function(
                 solver_key=function.solver_key,
                 version=function.solver_version,
                 inputs=JobInputs(values=joined_inputs or {}),
-                job_rest_interface_links=job_rest_interface_links,
+                job_links=job_rest_interface_links,
                 hidden=True,
                 x_simcore_parent_project_uuid=x_simcore_parent_project_uuid,
                 x_simcore_parent_node_id=x_simcore_parent_node_id,

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

@@ -31,7 +31,7 @@
 from .exceptions.backend_errors import JobAssetsMissingError
 from .exceptions.custom_errors import SolverServiceListJobsFiltersError
 from .models.api_resources import (
-    JobRestInterfaceLinks,
+    JobLinks,
     RelativeResourceName,
     compose_resource_name,
 )
@@ -213,7 +213,7 @@ async def create_project_marked_as_job(
         inputs: JobInputs,
         parent_project_uuid: ProjectID | None,
         parent_node_id: NodeID | None,
-        job_rest_interface_links: JobRestInterfaceLinks,
+        job_links: JobLinks,
         hidden: bool,
         project_name: str | None,
         description: str | None,
@@ -256,7 +256,7 @@ async def create_project_marked_as_job(
         job = create_job_from_project(
             solver_or_program=solver_or_program,
             project=new_project,
-            job_rest_interface_links=job_rest_interface_links,
+            job_links=job_links,
         )
         assert job.id == pre_job.id  # nosec
         assert job.name == pre_job.name  # nosec
@@ -316,7 +316,7 @@ async def create_solver_job(
         version: VersionStr,
         inputs: JobInputs,
         hidden: bool,
-        job_rest_interface_links: JobRestInterfaceLinks,
+        job_links: JobLinks,
         x_simcore_parent_project_uuid: ProjectID | None,
         x_simcore_parent_node_id: NodeID | None,
     ) -> Job:
@@ -333,7 +333,7 @@ async def create_solver_job(
             hidden=hidden,
             parent_project_uuid=x_simcore_parent_project_uuid,
             parent_node_id=x_simcore_parent_node_id,
-            job_rest_interface_links=job_rest_interface_links,
+            job_links=job_links,
         )
 
         return job

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

@@ -16,7 +16,7 @@
     complete_file_upload,
     get_upload_links_from_s3,
 )
-from simcore_service_api_server.models.api_resources import JobRestInterfaceLinks
+from simcore_service_api_server.models.api_resources import JobLinks
 
 from ..._service_jobs import JobService
 from ..._service_programs import ProgramService
@@ -172,7 +172,7 @@ async def create_program_job(
         name=program_key,
         version=version,
     )
-    job_rest_interface_links = JobRestInterfaceLinks(
+    job_rest_interface_links = JobLinks(
         url_template=None,
         runner_url_template=None,
         outputs_url_template=None,
@@ -185,7 +185,7 @@ async def create_program_job(
         inputs=inputs,
         parent_project_uuid=x_simcore_parent_project_uuid,
         parent_node_id=x_simcore_parent_node_id,
-        job_rest_interface_links=job_rest_interface_links,
+        job_links=job_rest_interface_links,
         hidden=False,
     )
 

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

@@ -104,7 +104,7 @@ async def create_solver_job(  # noqa: PLR0913
         hidden=hidden,
         x_simcore_parent_project_uuid=x_simcore_parent_project_uuid,
         x_simcore_parent_node_id=x_simcore_parent_node_id,
-        job_rest_interface_links=get_solver_job_rest_interface_links(
+        job_links=get_solver_job_rest_interface_links(
             url_for=url_for, solver_key=solver_key, version=version
         ),
     )

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

@@ -211,7 +211,7 @@ async def list_jobs(
         job = create_job_from_project(
             solver_or_program=solver,
             project=prj,
-            job_rest_interface_links=job_rest_interface_links,
+            job_links=job_rest_interface_links,
         )
         assert job.id == prj.uuid  # nosec
         assert job.name == prj.name  # nosec
@@ -261,7 +261,7 @@ async def list_jobs_paginated(
         create_job_from_project(
             solver_or_program=solver,
             project=prj,
-            job_rest_interface_links=job_rest_interface_links,
+            job_links=job_rest_interface_links,
         )
         for prj in projects_page.data
     ]
@@ -305,7 +305,7 @@ async def get_job(
     job = create_job_from_project(
         solver_or_program=solver,
         project=project,
-        job_rest_interface_links=job_rest_interface_links,
+        job_links=job_rest_interface_links,
     )
     assert job.id == job_id  # nosec
     return job  # nosec

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

@@ -102,7 +102,7 @@ def _url_missing_only_job_id(url: str | None) -> str | None:
     return url
 
 
-class JobRestInterfaceLinks(BaseModel):
+class JobLinks(BaseModel):
     url_template: Annotated[str | None, AfterValidator(_url_missing_only_job_id)]
     runner_url_template: str | None
     outputs_url_template: Annotated[

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

@@ -28,7 +28,7 @@
 from servicelib.logging_utils import LogLevelInt, LogMessageStr
 from starlette.datastructures import Headers
 
-from ...models.api_resources import JobRestInterfaceLinks
+from ...models.api_resources import JobLinks
 from ...models.schemas.files import File, UserFile
 from .._utils_pydantic import UriSchema
 from ..api_resources import (
@@ -327,8 +327,8 @@ def resource_name(self) -> str:
 
 def get_solver_job_rest_interface_links(
     *, url_for: Callable, solver_key: SolverKeyId, version: VersionStr
-) -> JobRestInterfaceLinks:
-    return JobRestInterfaceLinks(
+) -> JobLinks:
+    return JobLinks(
         url_template=url_for(
             "get_job",
             solver_key=solver_key,

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

@@ -4,17 +4,18 @@
 """
 
 import uuid
+from collections.abc import Callable
 from datetime import UTC, datetime
 from functools import lru_cache
 
 import arrow
 from models_library.api_schemas_webserver.projects import ProjectCreateNew, ProjectGet
 from models_library.api_schemas_webserver.projects_ui import StudyUI
-from models_library.basic_types import KeyIDStr
+from models_library.basic_types import KeyIDStr, VersionStr
 from models_library.projects import Project
 from models_library.projects_nodes import InputID
 from pydantic import TypeAdapter
-from simcore_service_api_server.models.api_resources import JobRestInterfaceLinks
+from simcore_service_api_server.models.api_resources import JobLinks
 
 from ..models.domain.projects import InputTypes, Node, SimCoreFileLink
 from ..models.schemas.files import File
@@ -26,7 +27,7 @@
     PercentageInt,
 )
 from ..models.schemas.programs import Program
-from ..models.schemas.solvers import Solver
+from ..models.schemas.solvers import Solver, SolverKeyId
 from .director_v2 import ComputationTaskGet
 
 # UTILS ------
@@ -181,11 +182,35 @@ def create_new_project_for_job(
     )
 
 
+def get_solver_job_rest_interface_links(
+    *, url_for: Callable, solver_key: SolverKeyId, version: VersionStr
+) -> JobLinks:
+    return JobLinks(
+        url_template=url_for(
+            "get_job",
+            solver_key=solver_key,
+            version=version,
+            job_id="{job_id}",
+        ),
+        runner_url_template=url_for(
+            "get_solver_release",
+            solver_key=solver_key,
+            version=version,
+        ),
+        outputs_url_template=url_for(
+            "get_job_outputs",
+            solver_key=solver_key,
+            version=version,
+            job_id="{job_id}",
+        ),
+    )
+
+
 def create_job_from_project(
     *,
     solver_or_program: Solver | Program,
     project: ProjectGet | Project,
-    job_rest_interface_links: JobRestInterfaceLinks,
+    job_links: JobLinks,
 ) -> Job:
     """
     Given a project, creates a job
@@ -215,9 +240,9 @@ def create_job_from_project(
         inputs_checksum=job_inputs.compute_checksum(),
         created_at=project.creation_date,  # type: ignore[arg-type]
         runner_name=solver_or_program_name,
-        url=job_rest_interface_links.url(job_id=job_id),
-        runner_url=job_rest_interface_links.runner_url(job_id=job_id),
-        outputs_url=job_rest_interface_links.outputs_url(job_id=job_id),
+        url=job_links.url(job_id=job_id),
+        runner_url=job_links.runner_url(job_id=job_id),
+        outputs_url=job_links.outputs_url(job_id=job_id),
     )
 
 

services/api-server/tests/unit/service/test_service_jobs.py

@@ -7,7 +7,7 @@
 from faker import Faker
 from pytest_mock import MockType
 from simcore_service_api_server._service_jobs import JobService
-from simcore_service_api_server.models.api_resources import JobRestInterfaceLinks
+from simcore_service_api_server.models.api_resources import JobLinks
 from simcore_service_api_server.models.schemas.jobs import Job, JobInputs
 from simcore_service_api_server.models.schemas.solvers import Solver
 
@@ -57,7 +57,7 @@ async def test_create_job(
     def mock_url_for(*args, **kwargs):
         return "https://example.com/api/v1/jobs/test-job"
 
-    job_rest_interface_links = JobRestInterfaceLinks(
+    job_rest_interface_links = JobLinks(
         url_template=_faker.url() + "/{job_id}",
         runner_url_template=_faker.url(),
         outputs_url_template=_faker.url() + "/{job_id}",
@@ -69,7 +69,7 @@ def mock_url_for(*args, **kwargs):
         inputs=inputs,
         parent_project_uuid=None,
         parent_node_id=None,
-        job_rest_interface_links=job_rest_interface_links,
+        job_links=job_rest_interface_links,
         hidden=False,
         project_name="Test Job Project",
         description="Test description",

services/api-server/tests/unit/test_services_solver_job_models_converters.py

@@ -7,7 +7,7 @@
 from models_library.projects import Project
 from models_library.projects_nodes import InputsDict, InputTypes, SimCoreFileLink
 from pydantic import RootModel, TypeAdapter, create_model
-from simcore_service_api_server.models.api_resources import JobRestInterfaceLinks
+from simcore_service_api_server.models.api_resources import JobLinks
 from simcore_service_api_server.models.schemas.files import File
 from simcore_service_api_server.models.schemas.jobs import ArgumentTypes, Job, JobInputs
 from simcore_service_api_server.models.schemas.solvers import Solver
@@ -209,7 +209,7 @@ def test_create_job_from_project(faker: Faker):
     solver_key = "simcore/services/comp/itis/sleeper"
     solver_version = "2.0.2"
 
-    fake_job_rest_interface_links = JobRestInterfaceLinks(
+    fake_job_rest_interface_links = JobLinks(
         url_template=faker.url() + "/{job_id}",
         runner_url_template=faker.url(),
         outputs_url_template=faker.url() + "/{job_id}",
@@ -227,7 +227,7 @@ def test_create_job_from_project(faker: Faker):
     job = create_job_from_project(
         solver_or_program=solver,
         project=project,
-        job_rest_interface_links=fake_job_rest_interface_links,
+        job_links=fake_job_rest_interface_links,
     )
 
     assert job.id == project.uuid