start moving out url_for

Author: bisgaard-itis

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

@@ -36,7 +36,11 @@
 from pydantic import ValidationError
 
 from ._service_jobs import JobService
-from .models.schemas.jobs import JobInputs, JobPricingSpecification
+from .models.schemas.jobs import (
+    JobInputs,
+    JobPricingSpecification,
+    get_solver_job_rest_interface_links,
+)
 from .services_rpc.wb_api_server import WbApiRpcClient
 
 
@@ -244,11 +248,16 @@ async def run_function(
             )
 
         if function.function_class == FunctionClass.SOLVER:
+            job_rest_interface_links = get_solver_job_rest_interface_links(
+                url_for=url_for,
+                solver_key=function.solver_key,
+                version=function.solver_version,
+            )
             solver_job = await self._job_service.create_solver_job(
                 solver_key=function.solver_key,
                 version=function.solver_version,
                 inputs=JobInputs(values=joined_inputs or {}),
-                url_for=url_for,
+                job_rest_interface_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

@@ -1,5 +1,4 @@
 import logging
-from collections.abc import Callable
 from dataclasses import dataclass
 from pathlib import Path
 from uuid import UUID
@@ -24,15 +23,18 @@
 from models_library.rpc.webserver.projects import ProjectJobRpcGet
 from models_library.rpc_pagination import PageLimitInt
 from models_library.users import UserID
-from pydantic import HttpUrl
 from servicelib.logging_utils import log_context
 
 from ._service_solvers import (
     SolverService,
 )
 from .exceptions.backend_errors import JobAssetsMissingError
 from .exceptions.custom_errors import SolverServiceListJobsFiltersError
-from .models.api_resources import RelativeResourceName, compose_resource_name
+from .models.api_resources import (
+    JobRestInterfaceLinks,
+    RelativeResourceName,
+    compose_resource_name,
+)
 from .models.basic_types import NameValueTuple, VersionStr
 from .models.schemas.jobs import (
     Job,
@@ -211,7 +213,7 @@ async def create_project_marked_as_job(
         inputs: JobInputs,
         parent_project_uuid: ProjectID | None,
         parent_node_id: NodeID | None,
-        url_for: Callable[..., HttpUrl],
+        job_rest_interface_links: JobRestInterfaceLinks,
         hidden: bool,
         project_name: str | None,
         description: str | None,
@@ -252,7 +254,9 @@ async def create_project_marked_as_job(
 
         # for consistency, it rebuild job
         job = create_job_from_project(
-            solver_or_program=solver_or_program, project=new_project, url_for=url_for
+            solver_or_program=solver_or_program,
+            project=new_project,
+            job_rest_interface_links=job_rest_interface_links,
         )
         assert job.id == pre_job.id  # nosec
         assert job.name == pre_job.name  # nosec
@@ -311,8 +315,8 @@ async def create_solver_job(
         solver_key: SolverKeyId,
         version: VersionStr,
         inputs: JobInputs,
-        url_for: Callable,
         hidden: bool,
+        job_rest_interface_links: JobRestInterfaceLinks,
         x_simcore_parent_project_uuid: ProjectID | None,
         x_simcore_parent_node_id: NodeID | None,
     ) -> Job:
@@ -326,10 +330,10 @@ async def create_solver_job(
             description=None,
             solver_or_program=solver,
             inputs=inputs,
-            url_for=url_for,
             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,
         )
 
         return job

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

@@ -16,6 +16,7 @@
     complete_file_upload,
     get_upload_links_from_s3,
 )
+from simcore_service_api_server.models.api_resources import JobRestInterfaceLinks
 
 from ..._service_jobs import JobService
 from ..._service_programs import ProgramService
@@ -171,6 +172,11 @@ async def create_program_job(
         name=program_key,
         version=version,
     )
+    job_rest_interface_links = JobRestInterfaceLinks(
+        url_template=None,
+        runner_url_template=None,
+        outputs_url_template=None,
+    )
 
     job, project = await job_service.create_project_marked_as_job(
         project_name=name,
@@ -179,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,
-        url_for=url_for,
+        job_rest_interface_links=job_rest_interface_links,
         hidden=False,
     )
 

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

@@ -24,6 +24,7 @@
     JobMetadataUpdate,
     JobPricingSpecification,
     JobStatus,
+    get_solver_job_rest_interface_links,
 )
 from ...models.schemas.solvers import Solver, SolverKeyId
 from ...services_http.director_v2 import DirectorV2Api
@@ -103,7 +104,9 @@ 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,
-        url_for=url_for,
+        job_rest_interface_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

@@ -38,6 +38,7 @@
     JobLog,
     JobMetadata,
     JobOutputs,
+    get_solver_job_rest_interface_links,
 )
 from ...models.schemas.jobs_filters import JobMetadataFilter
 from ...models.schemas.model_adapter import (
@@ -203,9 +204,14 @@ async def list_jobs(
     )
 
     jobs: deque[Job] = deque()
+    job_rest_interface_links = get_solver_job_rest_interface_links(
+        url_for=url_for, solver_key=solver_key, version=solver.version
+    )
     for prj in projects_page.data:
         job = create_job_from_project(
-            solver_or_program=solver, project=prj, url_for=url_for
+            solver_or_program=solver,
+            project=prj,
+            job_rest_interface_links=job_rest_interface_links,
         )
         assert job.id == prj.uuid  # nosec
         assert job.name == prj.name  # nosec
@@ -247,9 +253,16 @@ async def list_jobs_paginated(
     projects_page = await webserver_api.get_projects_w_solver_page(
         solver_name=solver.name, limit=page_params.limit, offset=page_params.offset
     )
+    job_rest_interface_links = get_solver_job_rest_interface_links(
+        url_for=url_for, solver_key=solver_key, version=version
+    )
 
     jobs: list[Job] = [
-        create_job_from_project(solver_or_program=solver, project=prj, url_for=url_for)
+        create_job_from_project(
+            solver_or_program=solver,
+            project=prj,
+            job_rest_interface_links=job_rest_interface_links,
+        )
         for prj in projects_page.data
     ]
 
@@ -285,8 +298,14 @@ async def get_job(
     )
     project: ProjectGet = await webserver_api.get_project(project_id=job_id)
 
+    job_rest_interface_links = get_solver_job_rest_interface_links(
+        url_for=url_for, solver_key=solver_key, version=version
+    )
+
     job = create_job_from_project(
-        solver_or_program=solver, project=project, url_for=url_for
+        solver_or_program=solver,
+        project=project,
+        job_rest_interface_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

@@ -1,8 +1,10 @@
 import re
 import urllib.parse
 from typing import Annotated, TypeAlias
+from uuid import UUID
 
-from pydantic import Field, TypeAdapter
+import parse
+from pydantic import AfterValidator, BaseModel, Field, HttpUrl, TypeAdapter
 from pydantic.types import StringConstraints
 
 # RESOURCE NAMES https://google.aip.dev/122
@@ -26,7 +28,6 @@
 # SEE https://tools.ietf.org/html/rfc3986#appendix-B
 #
 
-
 _RELATIVE_RESOURCE_NAME_RE = r"^([^\s/]+/?){1,10}$"
 
 
@@ -91,3 +92,39 @@ def split_resource_name_as_dict(
     """
     parts = split_resource_name(resource_name)
     return dict(zip(parts[::2], parts[1::2], strict=False))
+
+
+def _url_missing_only_job_id(url: str | None) -> str | None:
+    if url is None:
+        return None
+    if set(parse.compile(url).named_fields) != {"job_id"}:
+        raise ValueError(f"Missing job_id in {url=}")
+    return url
+
+
+class JobRestInterfaceLinks(BaseModel):
+    url_template: Annotated[str | None, AfterValidator(_url_missing_only_job_id)]
+    runner_url_template: str | None
+    outputs_url_template: Annotated[
+        str | None, AfterValidator(_url_missing_only_job_id)
+    ]
+
+    def url(self, job_id: UUID) -> HttpUrl | None:
+        if self.url_template is None:
+            return None
+        return TypeAdapter(HttpUrl).validate_python(
+            self.url_template.format(job_id=job_id)
+        )
+
+    def runner_url(self, job_id: UUID) -> HttpUrl | None:
+        assert job_id  # nosec
+        if self.runner_url_template is None:
+            return None
+        return TypeAdapter(HttpUrl).validate_python(self.runner_url_template)
+
+    def outputs_url(self, job_id: UUID) -> HttpUrl | None:
+        if self.outputs_url_template is None:
+            return None
+        return TypeAdapter(HttpUrl).validate_python(
+            self.outputs_url_template.format(job_id=job_id)
+        )

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

@@ -28,6 +28,7 @@
 from servicelib.logging_utils import LogLevelInt, LogMessageStr
 from starlette.datastructures import Headers
 
+from ...models.api_resources import JobRestInterfaceLinks
 from ...models.schemas.files import File, UserFile
 from .._utils_pydantic import UriSchema
 from ..api_resources import (
@@ -47,8 +48,8 @@
 #  - Input/outputs are defined in service metadata
 #  - custom metadata
 #
-from .programs import Program, ProgramKeyId
-from .solvers import Solver
+from .programs import ProgramKeyId
+from .solvers import SolverKeyId
 
 JobID: TypeAlias = UUID
 
@@ -324,42 +325,28 @@ def resource_name(self) -> str:
         return self.name
 
 
-def get_url(
-    solver_or_program: Solver | Program, url_for: Callable[..., HttpUrl], job_id: JobID
-) -> HttpUrl | None:
-    if isinstance(solver_or_program, Solver):
-        return url_for(
+def get_solver_job_rest_interface_links(
+    *, url_for: Callable, solver_key: SolverKeyId, version: VersionStr
+) -> JobRestInterfaceLinks:
+    return JobRestInterfaceLinks(
+        url_template=url_for(
             "get_job",
-            solver_key=solver_or_program.id,
-            version=solver_or_program.version,
-            job_id=job_id,
-        )
-    return None
-
-
-def get_runner_url(
-    solver_or_program: Solver | Program, url_for: Callable[..., HttpUrl]
-) -> HttpUrl | None:
-    if isinstance(solver_or_program, Solver):
-        return url_for(
+            solver_key=solver_key,
+            version=version,
+            job_id="{job_id}",
+        ),
+        runner_url_template=url_for(
             "get_solver_release",
-            solver_key=solver_or_program.id,
-            version=solver_or_program.version,
-        )
-    return None
-
-
-def get_outputs_url(
-    solver_or_program: Solver | Program, url_for: Callable[..., HttpUrl], job_id: JobID
-) -> HttpUrl | None:
-    if isinstance(solver_or_program, Solver):
-        return url_for(
+            solver_key=solver_key,
+            version=version,
+        ),
+        outputs_url_template=url_for(
             "get_job_outputs",
-            solver_key=solver_or_program.id,
-            version=solver_or_program.version,
-            job_id=job_id,
-        )
-    return None
+            solver_key=solver_key,
+            version=version,
+            job_id="{job_id}",
+        ),
+    )
 
 
 PercentageInt: TypeAlias = Annotated[int, Field(ge=0, le=100)]