✨ Prevent deprecated services to start (ITISFoundation#3350)

Author: sanderegg

packages/models-library/src/models_library/services.py

@@ -566,7 +566,10 @@ class ServiceMetaData(_BaseServiceCommonDataModel):
     name: Optional[str]
     thumbnail: Optional[HttpUrl]
     description: Optional[str]
-    deprecated: Optional[datetime]
+    deprecated: Optional[datetime] = Field(
+        default=None,
+        description="If filled with a date, then the service is to be deprecated at that date (e.g. cannot start anymore)",
+    )
 
     # user-defined metatada
     classifiers: Optional[list[str]]

packages/service-library/src/servicelib/aiohttp/requests_validation.py

@@ -4,7 +4,7 @@
 """
 
 from contextlib import contextmanager
-from typing import Iterator, Type, TypeVar
+from typing import Iterator, TypeVar
 
 from aiohttp import web
 from pydantic import BaseModel, ValidationError
@@ -52,7 +52,12 @@ def handle_validation_as_http_error(
                 for e in details
             ]
             error_str = json_dumps(
-                {"error": {"status": web.HTTPBadRequest.status_code, "errors": errors}}
+                {
+                    "error": {
+                        "status": web.HTTPUnprocessableEntity.status_code,
+                        "errors": errors,
+                    }
+                }
             )
         else:
             # NEW proposed error for https://github.com/ITISFoundation/osparc-simcore/issues/443
@@ -66,7 +71,7 @@ def handle_validation_as_http_error(
                 }
             )
 
-        raise web.HTTPBadRequest(
+        raise web.HTTPUnprocessableEntity(
             reason=reason_msg,
             text=error_str,
             content_type=MIMETYPE_APPLICATION_JSON,
@@ -82,7 +87,7 @@ def handle_validation_as_http_error(
 
 
 def parse_request_path_parameters_as(
-    parameters_schema: Type[ModelType],
+    parameters_schema: type[ModelType],
     request: web.Request,
     *,
     use_enveloped_error_v1: bool = True,
@@ -101,7 +106,7 @@ def parse_request_path_parameters_as(
 
 
 def parse_request_query_parameters_as(
-    parameters_schema: Type[ModelType],
+    parameters_schema: type[ModelType],
     request: web.Request,
     *,
     use_enveloped_error_v1: bool = True,
@@ -121,7 +126,7 @@ def parse_request_query_parameters_as(
 
 
 async def parse_request_body_as(
-    model_schema: Type[ModelType],
+    model_schema: type[ModelType],
     request: web.Request,
     *,
     use_enveloped_error_v1: bool = True,

packages/service-library/tests/aiohttp/test_requests_validation.py

@@ -192,7 +192,7 @@ async def test_parse_request_with_invalid_path_params(
         params=query_params.as_params(),
         json=body.dict(),
     )
-    assert r.status == web.HTTPBadRequest.status_code, f"{await r.text()}"
+    assert r.status == web.HTTPUnprocessableEntity.status_code, f"{await r.text()}"
 
     errors = await r.json()
     assert errors["error"].pop("resource")
@@ -221,7 +221,7 @@ async def test_parse_request_with_invalid_query_params(
         params={},
         json=body.dict(),
     )
-    assert r.status == web.HTTPBadRequest.status_code, f"{await r.text()}"
+    assert r.status == web.HTTPUnprocessableEntity.status_code, f"{await r.text()}"
 
     errors = await r.json()
     assert errors["error"].pop("resource")
@@ -250,7 +250,7 @@ async def test_parse_request_with_invalid_body(
         params=query_params.as_params(),
         json={"invalid": "body"},
     )
-    assert r.status == web.HTTPBadRequest.status_code, f"{await r.text()}"
+    assert r.status == web.HTTPUnprocessableEntity.status_code, f"{await r.text()}"
 
     errors = await r.json()
 

services/api-server/src/simcore_service_api_server/api/dependencies/application.py

@@ -2,9 +2,15 @@
 
 from fastapi import Request
 
+from ...core.settings import ApplicationSettings
+
 
 def get_reverse_url_mapper(request: Request) -> Callable:
     def reverse_url_mapper(name: str, **path_params: Any) -> str:
         return request.url_for(name, **path_params)
 
     return reverse_url_mapper
+
+
+def get_settings(request: Request) -> ApplicationSettings:
+    return request.app.state.settings

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

@@ -7,9 +7,10 @@
 from pydantic import ValidationError
 from pydantic.errors import PydanticValueError
 
+from ...core.settings import ApplicationSettings
 from ...models.schemas.solvers import Solver, SolverKeyId, VersionStr
 from ...modules.catalog import CatalogApi
-from ..dependencies.application import get_reverse_url_mapper
+from ..dependencies.application import get_reverse_url_mapper, get_settings
 from ..dependencies.authentication import get_current_user_id
 from ..dependencies.services import get_api_client
 
@@ -33,9 +34,12 @@ async def list_solvers(
     user_id: int = Depends(get_current_user_id),
     catalog_client: CatalogApi = Depends(get_api_client(CatalogApi)),
     url_for: Callable = Depends(get_reverse_url_mapper),
+    app_settings: ApplicationSettings = Depends(get_settings),
 ):
     """Lists all available solvers (latest version)"""
-    solvers: list[Solver] = await catalog_client.list_latest_releases(user_id)
+    solvers: list[Solver] = await catalog_client.list_latest_releases(
+        user_id, product_name=app_settings.API_SERVER_DEFAULT_PRODUCT_NAME
+    )
 
     for solver in solvers:
         solver.url = url_for(
@@ -50,11 +54,14 @@ async def list_solvers_releases(
     user_id: int = Depends(get_current_user_id),
     catalog_client: CatalogApi = Depends(get_api_client(CatalogApi)),
     url_for: Callable = Depends(get_reverse_url_mapper),
+    app_settings: ApplicationSettings = Depends(get_settings),
 ):
     """Lists all released solvers (all released versions)"""
     assert await catalog_client.is_responsive()  # nosec
 
-    solvers: list[Solver] = await catalog_client.list_solvers(user_id)
+    solvers: list[Solver] = await catalog_client.list_solvers(
+        user_id, product_name=app_settings.API_SERVER_DEFAULT_PRODUCT_NAME
+    )
 
     for solver in solvers:
         solver.url = url_for(
@@ -74,13 +81,18 @@ async def get_solver(
     user_id: int = Depends(get_current_user_id),
     catalog_client: CatalogApi = Depends(get_api_client(CatalogApi)),
     url_for: Callable = Depends(get_reverse_url_mapper),
+    app_settings: ApplicationSettings = Depends(get_settings),
 ) -> Solver:
     """Gets latest release of a solver"""
     # IMPORTANT: by adding /latest, we avoid changing the order of this entry in the router list
     # otherwise, {solver_key:path} will override and consume any of the paths that follow.
     try:
 
-        solver = await catalog_client.get_latest_release(user_id, solver_key)
+        solver = await catalog_client.get_latest_release(
+            user_id,
+            solver_key,
+            product_name=app_settings.API_SERVER_DEFAULT_PRODUCT_NAME,
+        )
         solver.url = url_for(
             "get_solver_release", solver_key=solver.id, version=solver.version
         )
@@ -101,10 +113,11 @@ async def list_solver_releases(
     user_id: int = Depends(get_current_user_id),
     catalog_client: CatalogApi = Depends(get_api_client(CatalogApi)),
     url_for: Callable = Depends(get_reverse_url_mapper),
+    app_settings: ApplicationSettings = Depends(get_settings),
 ):
     """Lists all releases of a given solver"""
     releases: list[Solver] = await catalog_client.list_solver_releases(
-        user_id, solver_key
+        user_id, solver_key, product_name=app_settings.API_SERVER_DEFAULT_PRODUCT_NAME
     )
 
     for solver in releases:
@@ -122,10 +135,16 @@ async def get_solver_release(
     user_id: int = Depends(get_current_user_id),
     catalog_client: CatalogApi = Depends(get_api_client(CatalogApi)),
     url_for: Callable = Depends(get_reverse_url_mapper),
+    app_settings: ApplicationSettings = Depends(get_settings),
 ) -> Solver:
     """Gets a specific release of a solver"""
     try:
-        solver = await catalog_client.get_solver(user_id, solver_key, version)
+        solver = await catalog_client.get_solver(
+            user_id,
+            solver_key,
+            version,
+            product_name=app_settings.API_SERVER_DEFAULT_PRODUCT_NAME,
+        )
 
         solver.url = url_for(
             "get_solver_release", solver_key=solver.id, version=solver.version

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

@@ -12,6 +12,7 @@
 from models_library.projects_nodes_io import BaseFileLink
 from pydantic.types import PositiveInt
 
+from ...core.settings import ApplicationSettings
 from ...models.domain.projects import NewProjectIn, Project
 from ...models.schemas.files import File
 from ...models.schemas.jobs import ArgumentType, Job, JobInputs, JobOutputs, JobStatus
@@ -30,7 +31,7 @@
     create_new_project_for_job,
 )
 from ...utils.solver_job_outputs import get_solver_output_results
-from ..dependencies.application import get_reverse_url_mapper
+from ..dependencies.application import get_reverse_url_mapper, get_settings
 from ..dependencies.authentication import get_current_user_id
 from ..dependencies.database import Engine, get_db_engine
 from ..dependencies.services import get_api_client
@@ -66,10 +67,16 @@ async def list_jobs(
     catalog_client: CatalogApi = Depends(get_api_client(CatalogApi)),
     webserver_api: AuthSession = Depends(get_webserver_session),
     url_for: Callable = Depends(get_reverse_url_mapper),
+    app_settings: ApplicationSettings = Depends(get_settings),
 ):
     """List of all jobs in a specific released solver"""
 
-    solver = await catalog_client.get_solver(user_id, solver_key, version)
+    solver = await catalog_client.get_solver(
+        user_id,
+        solver_key,
+        version,
+        product_name=app_settings.API_SERVER_DEFAULT_PRODUCT_NAME,
+    )
     logger.debug("Listing Jobs in Solver '%s'", solver.name)
 
     projects: list[Project] = await webserver_api.list_projects(solver.name)
@@ -97,14 +104,20 @@ async def create_job(
     webserver_api: AuthSession = Depends(get_webserver_session),
     director2_api: DirectorV2Api = Depends(get_api_client(DirectorV2Api)),
     url_for: Callable = Depends(get_reverse_url_mapper),
+    app_settings: ApplicationSettings = Depends(get_settings),
 ):
     """Creates a job in a specific release with given inputs.
 
     NOTE: This operation does **not** start the job
     """
 
     # ensures user has access to solver
-    solver = await catalog_client.get_solver(user_id, solver_key, version)
+    solver = await catalog_client.get_solver(
+        user_id,
+        solver_key,
+        version,
+        product_name=app_settings.API_SERVER_DEFAULT_PRODUCT_NAME,
+    )
 
     # creates NEW job as prototype
     pre_job = Job.create_solver_job(solver=solver, inputs=inputs)
@@ -173,12 +186,15 @@ async def start_job(
     job_id: UUID,
     user_id: PositiveInt = Depends(get_current_user_id),
     director2_api: DirectorV2Api = Depends(get_api_client(DirectorV2Api)),
+    app_settings: ApplicationSettings = Depends(get_settings),
 ):
 
     job_name = _compose_job_resource_name(solver_key, version, job_id)
     logger.debug("Start Job '%s'", job_name)
 
-    task = await director2_api.start_computation(job_id, user_id)
+    task = await director2_api.start_computation(
+        job_id, user_id, app_settings.API_SERVER_DEFAULT_PRODUCT_NAME
+    )
     job_status: JobStatus = create_jobstatus_from_task(task)
     return job_status
 

services/api-server/src/simcore_service_api_server/core/settings.py

@@ -95,6 +95,9 @@ class ApplicationSettings(BaseCustomSettings, MixinLoggingSettings):
     API_SERVER_DIRECTOR_V2: Optional[DirectorV2Settings] = Field(
         auto_default_from_env=True
     )
+    API_SERVER_DEFAULT_PRODUCT_NAME: str = Field(
+        default="osparc", description="The API-server default product name"
+    )
 
     # DIAGNOSTICS
     API_SERVER_TRACING: Optional[TracingSettings] = Field(auto_default_from_env=True)

services/api-server/src/simcore_service_api_server/modules/catalog.py

@@ -2,7 +2,7 @@
 import urllib.parse
 from dataclasses import dataclass
 from operator import attrgetter
-from typing import Callable, Optional, Tuple
+from typing import Callable, Optional
 
 from fastapi import FastAPI
 from models_library.services import ServiceDockerData, ServiceType
@@ -17,7 +17,7 @@
 logger = logging.getLogger(__name__)
 
 
-SolverNameVersionPair = Tuple[SolverKeyId, str]
+SolverNameVersionPair = tuple[SolverKeyId, str]
 
 
 class TruncatedCatalogServiceOut(ServiceDockerData):
@@ -78,12 +78,14 @@ class CatalogApi(BaseServiceClientApi):
     async def list_solvers(
         self,
         user_id: int,
+        *,
+        product_name: str,
         predicate: Optional[Callable[[Solver], bool]] = None,
     ) -> list[Solver]:
         resp = await self.client.get(
             "/services",
             params={"user_id": user_id, "details": True},
-            headers={"x-simcore-products-name": "osparc"},
+            headers={"x-simcore-products-name": product_name},
         )
         resp.raise_for_status()
 
@@ -109,7 +111,7 @@ async def list_solvers(
         return solvers
 
     async def get_solver(
-        self, user_id: int, name: SolverKeyId, version: VersionStr
+        self, user_id: int, name: SolverKeyId, version: VersionStr, *, product_name: str
     ) -> Solver:
 
         assert version != LATEST_VERSION  # nosec
@@ -120,7 +122,7 @@ async def get_solver(
         resp = await self.client.get(
             f"/services/{service_key}/{service_version}",
             params={"user_id": user_id},
-            headers={"x-simcore-products-name": "osparc"},
+            headers={"x-simcore-products-name": product_name},
         )
         resp.raise_for_status()
 
@@ -131,8 +133,12 @@ async def get_solver(
 
         return service.to_solver()
 
-    async def list_latest_releases(self, user_id: int) -> list[Solver]:
-        solvers: list[Solver] = await self.list_solvers(user_id)
+    async def list_latest_releases(
+        self, user_id: int, *, product_name: str
+    ) -> list[Solver]:
+        solvers: list[Solver] = await self.list_solvers(
+            user_id, product_name=product_name
+        )
 
         latest_releases = {}
         for solver in solvers:
@@ -143,16 +149,22 @@ async def list_latest_releases(self, user_id: int) -> list[Solver]:
         return list(latest_releases.values())
 
     async def list_solver_releases(
-        self, user_id: int, solver_key: SolverKeyId
+        self, user_id: int, solver_key: SolverKeyId, *, product_name: str
     ) -> list[Solver]:
         def _this_solver(solver: Solver) -> bool:
             return solver.id == solver_key
 
-        releases: list[Solver] = await self.list_solvers(user_id, _this_solver)
+        releases: list[Solver] = await self.list_solvers(
+            user_id, predicate=_this_solver, product_name=product_name
+        )
         return releases
 
-    async def get_latest_release(self, user_id: int, solver_key: SolverKeyId) -> Solver:
-        releases = await self.list_solver_releases(user_id, solver_key)
+    async def get_latest_release(
+        self, user_id: int, solver_key: SolverKeyId, *, product_name: str
+    ) -> Solver:
+        releases = await self.list_solver_releases(
+            user_id, solver_key, product_name=product_name
+        )
 
         # raises IndexError if None
         latest = sorted(releases, key=attrgetter("pep404_version"))[-1]