✨ Refactor services to improve dependency injection and enhance pagination handling

Author: pcrespov

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

@@ -5,7 +5,11 @@
 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 PageMetaInfoLimitOffset, PageOffsetInt
+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
@@ -24,8 +28,6 @@
 
 _logger = logging.getLogger(__name__)
 
-DEFAULT_PAGINATION_LIMIT = 999  # MAXIMUM_NUMBER_OF_ITEMS_PER_PAGE - 1
-
 
 class JobService:
     # clients
@@ -53,7 +55,7 @@ async def list_jobs_by_resource_prefix(
         *,
         job_parent_resource_name_prefix: str,
         offset: PageOffsetInt = 0,
-        limit: PageLimitInt = DEFAULT_PAGINATION_LIMIT,
+        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"""
 

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

@@ -1,6 +1,3 @@
-from typing import Annotated
-
-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
@@ -14,7 +11,7 @@
 class ProgramService:
     _catalog_service: CatalogService
 
-    def __init__(self, _catalog_service: Annotated[CatalogService, Depends()]):
+    def __init__(self, _catalog_service: CatalogService):
         self._catalog_service = _catalog_service
 
     async def get_program(

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

@@ -29,15 +29,31 @@
 class SolverService:
     _catalog_service: CatalogService
     _job_service: JobService
+    # context
+    _user_id: UserID
+    _product_name: ProductName
 
     def __init__(
         self,
         catalog_service: CatalogService,
         job_service: JobService,
+        user_id: UserID,
+        product_name: ProductName,
     ):
         self._catalog_service = catalog_service
         self._job_service = job_service
 
+        # context
+        if user_id != self._job_service._user_id:
+            msg = f"User ID {user_id} does not match job service user ID {self._job_service._user_id}"
+            raise ValueError(msg)
+        if product_name != self._job_service._product_name:
+            msg = f"Product name {product_name} does not match job service product name {self._job_service._product_name}"
+            raise ValueError(msg)
+
+        self._user_id = user_id
+        self._product_name = product_name
+
     async def get_solver(
         self,
         *,

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

@@ -1,9 +1,11 @@
+from models_library.products import ProductName
 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 simcore_service_api_server.models.schemas.studies import StudyID
 
 from ._service_jobs import JobService
@@ -16,11 +18,30 @@
 class StudyService:
     _job_service: JobService
 
+    # context
+    _user_id: UserID
+    _product_name: ProductName
+
     def __init__(
         self,
         job_service: JobService,
+        user_id: UserID,
+        product_name: ProductName,
     ):
         self._job_service = job_service
+        self._user_id = user_id
+        self._product_name = product_name
+
+        # context
+        if user_id != self._job_service._user_id:
+            msg = f"User ID {user_id} does not match job service user ID {self._job_service._user_id}"
+            raise ValueError(msg)
+        if product_name != self._job_service._product_name:
+            msg = f"Product name {product_name} does not match job service product name {self._job_service._product_name}"
+            raise ValueError(msg)
+
+        self._user_id = user_id
+        self._product_name = product_name
 
     async def list_jobs(
         self,

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

@@ -7,6 +7,7 @@
 from models_library.products import ProductName
 from models_library.users import UserID
 from servicelib.rabbitmq import RabbitMQRPCClient
+from simcore_service_api_server._service_programs import ProgramService
 from simcore_service_api_server._service_studies import StudyService
 
 from ..._service_jobs import JobService
@@ -76,21 +77,36 @@ def get_job_service(
 def get_solver_service(
     catalog_service: Annotated[CatalogService, Depends(get_catalog_service)],
     job_service: Annotated[JobService, Depends(get_job_service)],
+    user_id: Annotated[UserID, Depends(get_current_user_id)],
+    product_name: Annotated[ProductName, Depends(get_product_name)],
 ) -> SolverService:
     """
     "Assembles" the SolverService layer to the underlying service and client interfaces
     in the context of the rest controller (i.e. api/dependencies)
     """
-
     return SolverService(
         catalog_service=catalog_service,
         job_service=job_service,
+        user_id=user_id,
+        product_name=product_name,
     )
 
 
 def get_study_service(
     job_service: Annotated[JobService, Depends(get_job_service)],
+    user_id: Annotated[UserID, Depends(get_current_user_id)],
+    product_name: Annotated[ProductName, Depends(get_product_name)],
 ) -> StudyService:
     return StudyService(
         job_service=job_service,
+        user_id=user_id,
+        product_name=product_name,
+    )
+
+
+def get_program_service(
+    catalog_service: Annotated[CatalogService, Depends(get_catalog_service)],
+) -> ProgramService:
+    return ProgramService(
+        _catalog_service=catalog_service,
     )

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

@@ -31,8 +31,10 @@
 from ...models.schemas.jobs import Job, JobInputs
 from ...models.schemas.programs import Program, ProgramKeyId
 from ..dependencies.authentication import get_current_user_id, get_product_name
+from ..dependencies.services import get_job_service, get_program_service
 
 _logger = logging.getLogger(__name__)
+
 router = APIRouter()
 
 
@@ -49,7 +51,7 @@
 )
 async def list_programs(
     user_id: Annotated[PositiveInt, Depends(get_current_user_id)],
-    program_service: Annotated[ProgramService, Depends()],
+    program_service: Annotated[ProgramService, Depends(get_program_service)],
     url_for: Annotated[Callable, Depends(get_reverse_url_mapper)],
     product_name: Annotated[str, Depends(get_product_name)],
     page_params: Annotated[PaginationParams, Depends()],
@@ -89,7 +91,7 @@ async def list_programs(
 async def list_program_history(
     program_key: ProgramKeyId,
     user_id: Annotated[PositiveInt, Depends(get_current_user_id)],
-    program_service: Annotated[ProgramService, Depends()],
+    program_service: Annotated[ProgramService, Depends(get_program_service)],
     url_for: Annotated[Callable, Depends(get_reverse_url_mapper)],
     product_name: Annotated[str, Depends(get_product_name)],
     page_params: Annotated[PaginationParams, Depends()],
@@ -124,7 +126,7 @@ async def get_program_release(
     program_key: ProgramKeyId,
     version: VersionStr,
     user_id: Annotated[int, Depends(get_current_user_id)],
-    program_service: Annotated[ProgramService, Depends()],
+    program_service: Annotated[ProgramService, Depends(get_program_service)],
     url_for: Annotated[Callable, Depends(get_reverse_url_mapper)],
     product_name: Annotated[str, Depends(get_product_name)],
 ) -> Program:
@@ -163,8 +165,8 @@ async def create_program_job(
     program_key: ProgramKeyId,
     version: VersionStr,
     user_id: Annotated[PositiveInt, Depends(get_current_user_id)],
-    program_service: Annotated[ProgramService, Depends()],
-    job_service: Annotated[JobService, Depends()],
+    program_service: Annotated[ProgramService, Depends(get_program_service)],
+    job_service: Annotated[JobService, Depends(get_job_service)],
     url_for: Annotated[Callable, Depends(get_reverse_url_mapper)],
     product_name: Annotated[str, Depends(get_product_name)],
     x_simcore_parent_project_uuid: Annotated[ProjectID | None, Header()] = None,

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

@@ -22,7 +22,7 @@
 from ...services_rpc.catalog import CatalogService
 from ..dependencies.application import get_reverse_url_mapper
 from ..dependencies.authentication import get_current_user_id, get_product_name
-from ..dependencies.services import get_solver_service
+from ..dependencies.services import get_catalog_service, get_solver_service
 from ..dependencies.webserver_http import AuthSession, get_webserver_session
 from ._constants import (
     FMSG_CHANGELOG_NEW_IN_VERSION,
@@ -74,7 +74,7 @@
 )
 async def list_solvers(
     user_id: Annotated[int, Depends(get_current_user_id)],
-    catalog_service: Annotated[CatalogService, Depends()],
+    catalog_service: Annotated[CatalogService, Depends(get_catalog_service)],
     url_for: Annotated[Callable, Depends(get_reverse_url_mapper)],
     product_name: Annotated[str, Depends(get_product_name)],
 ):
@@ -348,7 +348,7 @@ async def list_solver_ports(
     solver_key: SolverKeyId,
     version: VersionStr,
     user_id: Annotated[int, Depends(get_current_user_id)],
-    catalog_service: Annotated[CatalogService, Depends()],
+    catalog_service: Annotated[CatalogService, Depends(get_catalog_service)],
     product_name: Annotated[str, Depends(get_product_name)],
 ):
     ports = await catalog_service.get_service_ports(

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

@@ -34,7 +34,7 @@
 )
 from ..dependencies.application import get_reverse_url_mapper
 from ..dependencies.authentication import get_current_user_id, get_product_name
-from ..dependencies.services import get_api_client, get_solver_service
+from ..dependencies.services import get_api_client, get_job_service, get_solver_service
 from ..dependencies.webserver_http import AuthSession, get_webserver_session
 from ._constants import (
     FMSG_CHANGELOG_ADDED_IN_VERSION,
@@ -92,7 +92,7 @@ async def create_solver_job(
     inputs: JobInputs,
     user_id: Annotated[PositiveInt, Depends(get_current_user_id)],
     solver_service: Annotated[SolverService, Depends(get_solver_service)],
-    job_service: Annotated[JobService, Depends()],
+    job_service: Annotated[JobService, Depends(get_job_service)],
     url_for: Annotated[Callable, Depends(get_reverse_url_mapper)],
     product_name: Annotated[str, Depends(get_product_name)],
     hidden: Annotated[bool, Query()] = True,

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

@@ -225,6 +225,7 @@ async def create_study_job(
 async def get_study_job(
     study_id: StudyID,
     job_id: JobID,
+    study_service: Annotated[StudyService, Depends(get_study_service)],
 ):
     msg = f"get study job study_id={study_id!r} job_id={job_id!r}. SEE https://github.com/ITISFoundation/osparc-simcore/issues/4177"
     raise NotImplementedError(msg)

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

@@ -1,7 +1,5 @@
 from functools import partial
-from typing import Annotated
 
-from fastapi import Depends
 from models_library.api_schemas_catalog.services import (
     LatestServiceGet,
     ServiceGetV2,
@@ -31,7 +29,6 @@
     ServiceForbiddenAccessError,
 )
 
-from ..api.dependencies.rabbitmq import get_rabbitmq_rpc_client
 from ..exceptions.service_errors_utils import service_exception_mapper
 
 _exception_mapper = partial(service_exception_mapper, service_name="CatalogService")
@@ -40,9 +37,7 @@
 class CatalogService:
     _client: RabbitMQRPCClient
 
-    def __init__(
-        self, client: Annotated[RabbitMQRPCClient, Depends(get_rabbitmq_rpc_client)]
-    ):
+    def __init__(self, client: RabbitMQRPCClient):
         self._client = client
 
     async def list_latest_releases(