Merge branch 'master' into mai/new-changelog-for-apis

Author: mergify[bot]

packages/models-library/src/models_library/api_schemas_webserver/projects.py

@@ -1,4 +1,4 @@
-""" rest API schema models for projects
+"""rest API schema models for projects
 
 
 SEE rationale in https://fastapi.tiangolo.com/tutorial/extra-models/#multiple-models
@@ -19,6 +19,7 @@
     PlainSerializer,
     field_validator,
 )
+from pydantic.config import JsonDict
 
 from ..api_schemas_long_running_tasks.tasks import TaskGet
 from ..basic_types import LongTruncatedStr, ShortTruncatedStr
@@ -53,9 +54,9 @@ class ProjectCreateNew(InputSchema):
     access_rights: dict[GroupIDStr, AccessRights]
 
     tags: Annotated[list[int], Field(default_factory=list)] = DEFAULT_FACTORY
-    classifiers: Annotated[
-        list[ClassifierID], Field(default_factory=list)
-    ] = DEFAULT_FACTORY
+    classifiers: Annotated[list[ClassifierID], Field(default_factory=list)] = (
+        DEFAULT_FACTORY
+    )
 
     ui: StudyUI | None = None
 
@@ -143,7 +144,31 @@ class ProjectGet(OutputSchema):
         none_to_empty_str_pre_validator
     )
 
-    model_config = ConfigDict(frozen=False)
+    @staticmethod
+    def _update_json_schema_extra(schema: JsonDict) -> None:
+        schema.update(
+            examples=[
+                {
+                    "uuid": "a8b0f384-bd08-4793-ab25-65d5a755f4b6",
+                    "name": "My Project",
+                    "description": "This is a sample project",
+                    "thumbnail": "https://example.com/thumbnail.png",
+                    "workbench": {},
+                    "prj_owner": "[email protected]",
+                    "access_rights": {},
+                    "trashed_at": None,
+                    "trashed_by": None,
+                    "dev": {},
+                    "tags": [],
+                    "workspace_id": None,
+                    "folder_id": None,
+                    "creation_date": "2023-01-01T00:00:00Z",
+                    "last_change_date": "2023-01-02T00:00:00Z",
+                }
+            ]
+        )
+
+    model_config = ConfigDict(frozen=False, json_schema_extra=_update_json_schema_extra)
 
     @classmethod
     def from_domain_model(cls, project_data: dict[str, Any]) -> Self:
@@ -168,8 +193,7 @@ def from_domain_model(cls, project_data: dict[str, Any]) -> Self:
 TaskProjectGet: TypeAlias = TaskGet
 
 
-class ProjectListItem(ProjectGet):
-    ...
+class ProjectListItem(ProjectGet): ...
 
 
 class ProjectReplace(InputSchema):

packages/postgres-database/src/simcore_postgres_database/models/products.py

@@ -51,7 +51,7 @@ class Vendor(TypedDict, total=False):
     invitation_url: str  # How to request a trial invitation? (if applies)
     invitation_form: bool  # If True, it takes precendence over invitation_url and asks the FE to show the form (if defined)
 
-    release_notes_url_template: str  # a template url where `{vtag}` will be replaced, eg: "http://example.com/{vtag}.md"
+    release_notes_url_template: str  # a template url where `{vtag}` will be replaced, eg: "https://example.com/{vtag}.md"
 
     ui: VendorUI
 

services/api-server/docs/api-server.drawio.svg

@@ -2365,7 +2365,7 @@
           "solvers"
         ],
         "summary": "List Jobs",
-        "description": "\ud83d\udea8 **Deprecated**: This endpoint is deprecated and will be removed in a future release.\nPlease use `GET /{solver_key}/releases/{version}/jobs/page` instead.\n\n\n\nList of jobs in a specific released solver\n\nNew in *version 0.5*\n\nRemoved in *version 0.7*: This endpoint is deprecated and will be removed in a future version",
+        "description": "\ud83d\udea8 **Deprecated**: This endpoint is deprecated and will be removed in a future release.\nPlease use `GET /{solver_key}/releases/{version}/jobs/page` instead.\n\n\n\nList of jobs in a specific released solver (limited to 20 jobs)\n\nNew in *version 0.5*\n\nRemoved in *version 0.7*: This endpoint is deprecated and will be removed in a future version",
         "operationId": "list_jobs",
         "security": [
           {

services/api-server/openapi.json

@@ -1,30 +1,27 @@
 import logging
 from collections.abc import Callable
-from typing import Annotated
+from dataclasses import dataclass
 
-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.rest_pagination import (
+    MAXIMUM_NUMBER_OF_ITEMS_PER_PAGE,
+    PageMetaInfoLimitOffset,
+    PageOffsetInt,
+)
+from models_library.rpc_pagination import PageLimitInt
 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
 from .services_http.solver_job_models_converters import (
     create_job_from_project,
+    create_job_inputs_from_node_inputs,
     create_new_project_for_job,
 )
 from .services_http.webserver import AuthSession
@@ -33,25 +30,60 @@
 _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
+@dataclass(frozen=True, kw_only=True)
+class JobService:
+    _web_rest_client: AuthSession
+    _web_rpc_client: WbApiRpcClient
+    user_id: UserID
+    product_name: ProductName
 
-    def __init__(
+    async def list_jobs(
         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
+        filter_by_job_parent_resource_name_prefix: str,
+        pagination_offset: PageOffsetInt = 0,
+        pagination_limit: PageLimitInt = MAXIMUM_NUMBER_OF_ITEMS_PER_PAGE - 1,
+    ) -> tuple[list[Job], PageMetaInfoLimitOffset]:
+        """Lists all jobs for a user with pagination based on resource name prefix"""
+
+        # 1. List projects marked as jobs
+        projects_page = await self._web_rpc_client.list_projects_marked_as_jobs(
+            product_name=self.product_name,
+            user_id=self.user_id,
+            offset=pagination_offset,
+            limit=pagination_limit,
+            job_parent_resource_name_prefix=filter_by_job_parent_resource_name_prefix,
+        )
+
+        # 2. Convert projects to jobs
+        jobs: list[Job] = []
+        for project_job in projects_page.data:
+            assert (  # nosec
+                len(project_job.workbench) == 1
+            ), "Expected only one solver node in workbench"
+
+            solver_node = next(iter(project_job.workbench.values()))
+            job_inputs: JobInputs = create_job_inputs_from_node_inputs(
+                inputs=solver_node.inputs or {}
+            )
+            assert project_job.job_parent_resource_name  # nosec
+
+            jobs.append(
+                Job(
+                    id=project_job.uuid,
+                    name=Job.compose_resource_name(
+                        project_job.job_parent_resource_name, project_job.uuid
+                    ),
+                    inputs_checksum=job_inputs.compute_checksum(),
+                    created_at=project_job.created_at,
+                    runner_name=project_job.job_parent_resource_name,
+                    url=None,
+                    runner_url=None,
+                    outputs_url=None,
+                )
+            )
+
+        return jobs, projects_page.meta
 
     async def create_job(
         self,
@@ -65,8 +97,10 @@ async def create_job(
         project_name: str | None,
         description: str | None,
     ) -> tuple[Job, ProjectGet]:
-        """If no project_name is provided, the job name is used as project name."""
+        """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
         )
@@ -80,15 +114,15 @@ async def create_job(
                 description=description,
                 project_name=project_name,
             )
-            new_project: ProjectGet = await self._web_rest_api.create_project(
+            new_project: ProjectGet = await self._web_rest_client.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,
+            await self._web_rpc_client.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,
             )

services/api-server/src/simcore_service_api_server/_service_job.py renamed to services/api-server/src/simcore_service_api_server/_service_jobs.py

@@ -1,6 +1,5 @@
-from typing import Annotated
+from dataclasses import dataclass
 
-from fastapi import Depends
 from models_library.api_schemas_catalog.services import ServiceListFilters
 from models_library.basic_types import VersionStr
 from models_library.rest_pagination import PageMetaInfoLimitOffset
@@ -11,25 +10,19 @@
 from .services_rpc.catalog import CatalogService
 
 
+@dataclass(frozen=True, kw_only=True)
 class ProgramService:
-    _catalog_service: CatalogService
-
-    def __init__(self, _catalog_service: Annotated[CatalogService, Depends()]):
-        self._catalog_service = _catalog_service
+    catalog_service: CatalogService
 
     async def get_program(
         self,
         *,
-        user_id: int,
         name: ProgramKeyId,
         version: VersionStr,
-        product_name: str,
     ) -> Program:
-        service = await self._catalog_service.get(
-            user_id=user_id,
+        service = await self.catalog_service.get(
             name=name,
             version=version,
-            product_name=product_name,
         )
         assert service.service_type == ServiceType.DYNAMIC  # nosec
 
@@ -38,16 +31,12 @@ async def get_program(
     async def list_latest_programs(
         self,
         *,
-        user_id: int,
-        product_name: str,
-        offset: NonNegativeInt,
-        limit: PositiveInt,
+        pagination_offset: NonNegativeInt,
+        pagination_limit: PositiveInt,
     ) -> tuple[list[Program], PageMetaInfoLimitOffset]:
-        page, page_meta = await self._catalog_service.list_latest_releases(
-            user_id=user_id,
-            product_name=product_name,
-            offset=offset,
-            limit=limit,
+        page, page_meta = await self.catalog_service.list_latest_releases(
+            pagination_offset=pagination_offset,
+            pagination_limit=pagination_limit,
             filters=ServiceListFilters(service_type=ServiceType.DYNAMIC),
         )
 
@@ -57,27 +46,21 @@ async def list_latest_programs(
     async def list_program_history(
         self,
         *,
-        user_id: int,
         program_key: ProgramKeyId,
-        product_name: str,
         offset: NonNegativeInt,
         limit: PositiveInt,
     ) -> tuple[list[Program], PageMetaInfoLimitOffset]:
-        page, page_meta = await self._catalog_service.list_release_history_latest_first(
-            user_id=user_id,
-            service_key=program_key,
-            product_name=product_name,
-            offset=offset,
-            limit=limit,
+        page, page_meta = await self.catalog_service.list_release_history_latest_first(
+            filter_by_service_key=program_key,
+            pagination_offset=offset,
+            pagination_limit=limit,
         )
         if len(page) == 0:
             return [], page_meta
 
-        program_instance = await self._catalog_service.get(
-            user_id=user_id,
+        program_instance = await self.catalog_service.get(
             name=program_key,
             version=page[-1].version,
-            product_name=product_name,
         )
 
         items = [