🐛 Refactor pagination parameters to use optional types across multiple services and routes

Author: pcrespov

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

@@ -2,12 +2,12 @@
 from collections.abc import Callable
 from dataclasses import dataclass
 
+from common_library.exclude import as_dict_exclude_none
 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,
 )
@@ -43,19 +43,22 @@ async def list_jobs(
         job_parent_resource_name: str,
         *,
         filter_any_custom_metadata: list[NameValueTuple] | None = None,
-        pagination_offset: PageOffsetInt = 0,
-        pagination_limit: PageLimitInt = MAXIMUM_NUMBER_OF_ITEMS_PER_PAGE - 1,
+        pagination_offset: PageOffsetInt | None = None,
+        pagination_limit: PageLimitInt | None = None,
     ) -> tuple[list[Job], PageMetaInfoLimitOffset]:
         """Lists all jobs for a user with pagination based on resource name prefix"""
 
+        pagination_kwargs = as_dict_exclude_none(
+            offset=pagination_offset, limit=pagination_limit
+        )
+
         # 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,
-            pagination_offset=pagination_offset,
-            pagination_limit=pagination_limit,
             filter_by_job_parent_resource_name_prefix=job_parent_resource_name,
             filter_any_custom_metadata=filter_any_custom_metadata,
+            **pagination_kwargs,
         )
 
         # 2. Convert projects to jobs

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

@@ -2,9 +2,12 @@
 
 from models_library.api_schemas_catalog.services import ServiceListFilters
 from models_library.basic_types import VersionStr
-from models_library.rest_pagination import PageMetaInfoLimitOffset
+from models_library.rest_pagination import (
+    PageLimitInt,
+    PageMetaInfoLimitOffset,
+    PageOffsetInt,
+)
 from models_library.services_enums import ServiceType
-from pydantic import NonNegativeInt, PositiveInt
 
 from .models.schemas.programs import Program, ProgramKeyId
 from .services_rpc.catalog import CatalogService
@@ -31,8 +34,8 @@ async def get_program(
     async def list_latest_programs(
         self,
         *,
-        pagination_offset: NonNegativeInt,
-        pagination_limit: PositiveInt,
+        pagination_offset: PageOffsetInt | None = None,
+        pagination_limit: PageLimitInt | None = None,
     ) -> tuple[list[Program], PageMetaInfoLimitOffset]:
         page, page_meta = await self.catalog_service.list_latest_releases(
             pagination_offset=pagination_offset,
@@ -47,13 +50,13 @@ async def list_program_history(
         self,
         *,
         program_key: ProgramKeyId,
-        offset: NonNegativeInt,
-        limit: PositiveInt,
+        pagination_offset: PageOffsetInt | None = None,
+        pagination_limit: PageLimitInt | None = None,
     ) -> tuple[list[Program], PageMetaInfoLimitOffset]:
         page, page_meta = await self.catalog_service.list_release_history_latest_first(
             filter_by_service_key=program_key,
-            pagination_offset=offset,
-            pagination_limit=limit,
+            pagination_offset=pagination_offset,
+            pagination_limit=pagination_limit,
         )
         if len(page) == 0:
             return [], page_meta

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

@@ -90,11 +90,11 @@ async def get_latest_release(
     async def list_jobs(
         self,
         *,
+        pagination_offset: PageOffsetInt | None = None,
+        pagination_limit: PageLimitInt | None = None,
         filter_by_solver_key: SolverKeyId | None = None,
         filter_by_solver_version: VersionStr | None = None,
         filter_any_custom_metadata: list[NameValueTuple] | None = None,
-        pagination_offset: PageOffsetInt = 0,
-        pagination_limit: PageLimitInt = DEFAULT_PAGINATION_LIMIT,
     ) -> tuple[list[Job], PageMetaInfoLimitOffset]:
         """Lists all solver jobs for a user with pagination"""
 
@@ -124,8 +124,8 @@ async def solver_release_history(
         self,
         *,
         solver_key: SolverKeyId,
-        pagination_offset: PageOffsetInt,
-        pagination_limit: PageLimitInt,
+        pagination_offset: PageOffsetInt | None = None,
+        pagination_limit: PageLimitInt | None = None,
     ) -> tuple[list[Solver], PageMetaInfoLimitOffset]:
 
         releases, page_meta = (
@@ -155,8 +155,8 @@ async def solver_release_history(
     async def list_all_solvers(
         self,
         *,
-        pagination_offset: PageOffsetInt,
-        pagination_limit: PageLimitInt,
+        pagination_offset: PageOffsetInt | None = None,
+        pagination_limit: PageLimitInt | None = None,
         filter_by_solver_key_pattern: str | None = None,
         filter_by_version_display_pattern: str | None = None,
     ) -> tuple[list[Solver], PageMetaInfoLimitOffset]:
@@ -196,8 +196,8 @@ async def list_all_solvers(
     async def latest_solvers(
         self,
         *,
-        pagination_offset: PageOffsetInt,
-        pagination_limit: PageLimitInt,
+        pagination_offset: PageOffsetInt | None = None,
+        pagination_limit: PageLimitInt | None = None,
         filter_by_solver_key_pattern: str | None = None,
         filter_by_version_display_pattern: str | None = None,
     ) -> tuple[list[Solver], PageMetaInfoLimitOffset]:

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

@@ -36,8 +36,8 @@ async def list_jobs(
         self,
         *,
         filter_by_study_id: StudyID | None = None,
-        pagination_offset: PageOffsetInt = 0,
-        pagination_limit: PageLimitInt = DEFAULT_PAGINATION_LIMIT,
+        pagination_offset: PageOffsetInt | None = None,
+        pagination_limit: PageLimitInt | None = None,
     ) -> tuple[list[Job], PageMetaInfoLimitOffset]:
         """Lists all solver jobs for a user with pagination"""
 

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

@@ -90,8 +90,8 @@ async def list_program_history(
 ):
     programs, page_meta = await program_service.list_program_history(
         program_key=program_key,
-        offset=page_params.offset,
-        limit=page_params.limit,
+        pagination_offset=page_params.offset,
+        pagination_limit=page_params.limit,
     )
     page_params.limit = page_meta.limit
     page_params.offset = page_meta.offset

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

@@ -20,7 +20,8 @@
 )
 from models_library.basic_types import SHA256Str
 from models_library.generics import Envelope
-from pydantic import AnyUrl, PositiveInt
+from models_library.rest_pagination import PageLimitInt, PageOffsetInt
+from pydantic import AnyUrl
 from settings_library.tracing import TracingSettings
 from starlette.datastructures import URL
 
@@ -97,8 +98,8 @@ async def search_owned_files(
         user_id: int,
         file_id: UUID | None,
         sha256_checksum: SHA256Str | None = None,
-        limit: PositiveInt | None = None,
-        offset: PositiveInt | None = None,
+        limit: PageLimitInt | None = None,
+        offset: PageOffsetInt | None = None,
     ) -> list[StorageFileMetaData]:
         # NOTE: can NOT use /locations/0/files/metadata with uuid_filter=api/ because
         # logic in storage 'wrongly' assumes that all data is associated to a project and

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

@@ -38,7 +38,7 @@
 from models_library.generics import Envelope
 from models_library.projects import ProjectID
 from models_library.projects_nodes_io import NodeID
-from models_library.rest_pagination import Page
+from models_library.rest_pagination import Page, PageLimitInt, PageOffsetInt
 from models_library.utils.fastapi_encoders import jsonable_encoder
 from pydantic import PositiveInt
 from servicelib.aiohttp.long_running_tasks.server import TaskStatus
@@ -353,7 +353,7 @@ async def get_project(self, *, project_id: UUID) -> ProjectGet:
         return data
 
     async def get_projects_w_solver_page(
-        self, *, solver_name: str, limit: int, offset: int
+        self, *, solver_name: str, limit: PageLimitInt, offset: PageOffsetInt
     ) -> Page[ProjectGet]:
         assert not solver_name.endswith("/")  # nosec
 
@@ -364,7 +364,7 @@ async def get_projects_w_solver_page(
             search_by_project_name=solver_name,
         )
 
-    async def get_projects_page(self, *, limit: int, offset: int):
+    async def get_projects_page(self, *, limit: PageLimitInt, offset: PageOffsetInt):
         return await self._page_projects(
             limit=limit,
             offset=offset,

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

@@ -1,6 +1,8 @@
 from dataclasses import dataclass
 from functools import partial
+from typing import Any
 
+from common_library.exclude import as_dict_exclude_none
 from models_library.api_schemas_catalog.services import (
     LatestServiceGet,
     ServiceGetV2,
@@ -10,7 +12,6 @@
 from models_library.api_schemas_catalog.services_ports import ServicePortGet
 from models_library.products import ProductName
 from models_library.rest_pagination import (
-    DEFAULT_NUMBER_OF_ITEMS_PER_PAGE,
     PageLimitInt,
     PageMetaInfoLimitOffset,
     PageOffsetInt,
@@ -36,6 +37,16 @@
 _exception_mapper = partial(service_exception_mapper, service_name="CatalogService")
 
 
+def _create_page_meta_info(page: Any) -> PageMetaInfoLimitOffset:
+    """Creates a PageMetaInfoLimitOffset from an RPC response page."""
+    return PageMetaInfoLimitOffset(
+        limit=page.meta.limit,
+        offset=page.meta.offset,
+        total=page.meta.total,
+        count=page.meta.count,
+    )
+
+
 @dataclass(frozen=True, kw_only=True)
 class CatalogService:
     _rpc_client: RabbitMQRPCClient
@@ -45,56 +56,53 @@ class CatalogService:
     async def list_latest_releases(
         self,
         *,
-        pagination_offset: PageOffsetInt = 0,
-        pagination_limit: PageLimitInt = DEFAULT_NUMBER_OF_ITEMS_PER_PAGE,
+        pagination_offset: PageOffsetInt | None = None,
+        pagination_limit: PageLimitInt | None = None,
         filters: ServiceListFilters | None = None,
     ) -> tuple[list[LatestServiceGet], PageMetaInfoLimitOffset]:
 
+        pagination_kwargs = as_dict_exclude_none(
+            offset=pagination_offset, limit=pagination_limit
+        )
+
         page = await catalog_rpc.list_services_paginated(
             self._rpc_client,
             product_name=self.product_name,
             user_id=self.user_id,
-            offset=pagination_offset,
-            limit=pagination_limit,
             filters=filters,
+            **pagination_kwargs,
         )
-        meta = PageMetaInfoLimitOffset(
-            limit=page.meta.limit,
-            offset=page.meta.offset,
-            total=page.meta.total,
-            count=page.meta.count,
-        )
+        meta = _create_page_meta_info(page)
         return page.data, meta
 
     async def list_release_history_latest_first(
         self,
         *,
         filter_by_service_key: ServiceKey,
-        pagination_offset: PageOffsetInt = 0,
-        pagination_limit: PageLimitInt = DEFAULT_NUMBER_OF_ITEMS_PER_PAGE,
+        pagination_offset: PageOffsetInt | None = None,
+        pagination_limit: PageLimitInt | None = None,
     ) -> tuple[list[ServiceRelease], PageMetaInfoLimitOffset]:
 
+        pagination_kwargs = as_dict_exclude_none(
+            offset=pagination_offset, limit=pagination_limit
+        )
+
         page = await catalog_rpc.list_my_service_history_latest_first(
             self._rpc_client,
             product_name=self.product_name,
             user_id=self.user_id,
             service_key=filter_by_service_key,
-            offset=pagination_offset,
-            limit=pagination_limit,
-        )
-        meta = PageMetaInfoLimitOffset(
-            limit=page.meta.limit,
-            offset=page.meta.offset,
-            total=page.meta.total,
-            count=page.meta.count,
+            **pagination_kwargs,
         )
+
+        meta = _create_page_meta_info(page)
         return page.data, meta
 
     async def list_all_services_summaries(
         self,
         *,
-        pagination_offset: PageOffsetInt = 0,
-        pagination_limit: PageLimitInt = DEFAULT_NUMBER_OF_ITEMS_PER_PAGE,
+        pagination_offset: PageOffsetInt | None = None,
+        pagination_limit: PageLimitInt | None = None,
         filters: ServiceListFilters | None = None,
     ) -> tuple[list[ServiceSummary], PageMetaInfoLimitOffset]:
         """Lists all services with pagination, including all versions of each service.
@@ -109,20 +117,19 @@ async def list_all_services_summaries(
         Returns:
             Tuple containing list of service summaries and pagination metadata
         """
+
+        pagination_kwargs = as_dict_exclude_none(
+            offset=pagination_offset, limit=pagination_limit
+        )
+
         page = await catalog_rpc.list_all_services_summaries_paginated(
             self._rpc_client,
             product_name=self.product_name,
             user_id=self.user_id,
-            offset=pagination_offset,
-            limit=pagination_limit,
             filters=filters,
+            **pagination_kwargs,
         )
-        meta = PageMetaInfoLimitOffset(
-            limit=page.meta.limit,
-            offset=page.meta.offset,
-            total=page.meta.total,
-            count=page.meta.count,
-        )
+        meta = _create_page_meta_info(page)
         return page.data, meta
 
     @_exception_mapper(