adding pagination to history

Author: pcrespov

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

@@ -323,11 +323,16 @@ def _update_json_schema_extra(schema: JsonDict) -> None:
     )
 
 
-PageRpcServicesGetV2: TypeAlias = PageRpc[
+PageRpcLatestServiceGet: TypeAlias = PageRpc[
     # WARNING: keep this definition in models_library and not in the RPC interface
     LatestServiceGet
 ]
 
+PageRpcServiceRelease: TypeAlias = PageRpc[
+    # WARNING: keep this definition in models_library and not in the RPC interface
+    ServiceRelease
+]
+
 ServiceResourcesGet: TypeAlias = ServiceResourcesDict
 
 

packages/pytest-simcore/src/pytest_simcore/helpers/catalog_rpc_server.py

@@ -10,7 +10,9 @@
     CatalogServiceUpdate,
 )
 from models_library.products import ProductName
+from models_library.rest_pagination import PageOffsetInt
 from models_library.rpc_pagination import PageLimitInt, PageRpc
+from models_library.services_history import ServiceRelease
 from models_library.services_types import ServiceKey, ServiceVersion
 from models_library.users import UserID
 from pydantic import NonNegativeInt, TypeAdapter
@@ -84,3 +86,33 @@ async def update_service(
         got.version = service_version
         got.key = service_key
         return got.model_copy(update=update.model_dump(exclude_unset=True))
+
+    async def get_my_service_history(
+        self,
+        rpc_client: RabbitMQRPCClient,
+        *,
+        product_name: ProductName,
+        user_id: UserID,
+        service_key: ServiceKey,
+        limit: PageLimitInt,
+        offset: PageOffsetInt,
+    ) -> PageRpc[ServiceRelease]:
+
+        assert rpc_client
+        assert product_name
+        assert user_id
+        assert service_key
+
+        items = TypeAdapter(list[ServiceRelease]).validate_python(
+            [
+                ServiceRelease.model_json_schema()["example"],
+            ]
+        )
+        total_count = len(items)
+
+        return PageRpc[ServiceRelease].create(
+            items[offset : offset + limit],
+            total=total_count,
+            limit=limit,
+            offset=offset,
+        )

packages/service-library/src/servicelib/rabbitmq/rpc_interfaces/catalog/services.py

@@ -7,6 +7,8 @@
 from models_library.api_schemas_catalog.services import (
     LatestServiceGet,
     MyServiceGet,
+    PageRpcLatestServiceGet,
+    PageRpcServiceRelease,
     ServiceGetV2,
     ServiceRelease,
     ServiceUpdateV2,
@@ -37,7 +39,7 @@ async def list_services_paginated(  # pylint: disable=too-many-arguments
     user_id: UserID,
     limit: PageLimitInt = DEFAULT_NUMBER_OF_ITEMS_PER_PAGE,
     offset: PageOffsetInt = 0,
-) -> PageRpc[LatestServiceGet]:
+) -> PageRpcLatestServiceGet:
     """
     Raises:
         ValidationError: on invalid arguments
@@ -245,7 +247,9 @@ async def get_my_service_history(  # pylint: disable=too-many-arguments
     product_name: ProductName,
     user_id: UserID,
     service_key: ServiceKey,
-) -> list[ServiceRelease]:
+    limit: PageLimitInt = DEFAULT_NUMBER_OF_ITEMS_PER_PAGE,
+    offset: PageOffsetInt = 0,
+) -> PageRpcServiceRelease:
     """
     Raises:
         ValidationError: on invalid arguments
@@ -256,21 +260,28 @@ async def _call(
         product_name: ProductName,
         user_id: UserID,
         service_key: ServiceKey,
+        limit: PageLimitInt,
+        offset: PageOffsetInt,
     ):
         return await rpc_client.request(
             CATALOG_RPC_NAMESPACE,
             TypeAdapter(RPCMethodName).validate_python("get_my_service_history"),
             product_name=product_name,
             user_id=user_id,
             service_key=service_key,
+            limit=limit,
+            offset=offset,
         )
 
     result = await _call(
         product_name=product_name,
         user_id=user_id,
         service_key=service_key,
+        limit=limit,
+        offset=offset,
     )
+
     assert (  # nosec
-        TypeAdapter(list[ServiceRelease]).validate_python(result) is not None
+        TypeAdapter(PageRpcServiceRelease).validate_python(result) is not None
     )
-    return cast(list[ServiceRelease], result)
+    return cast(PageRpc[ServiceRelease], result)

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

@@ -55,21 +55,21 @@ async def list_release_history(
         limit: PageLimitInt = DEFAULT_NUMBER_OF_ITEMS_PER_PAGE,
     ) -> tuple[list[ServiceRelease], PageMetaInfoLimitOffset]:
 
-        data = await catalog_rpc.get_my_service_history(
+        page = await catalog_rpc.get_my_service_history(
             self._client,
             product_name=product_name,
             user_id=user_id,
             service_key=service_key,
-            # TODO: offset=offset,
-            # TODO: limit=limit,
+            offset=offset,
+            limit=limit,
         )
         meta = PageMetaInfoLimitOffset(
-            limit=limit,
-            offset=offset,
-            total=len(data),
-            count=len(data),
+            limit=page.meta.limit,
+            offset=page.meta.offset,
+            total=page.meta.total,
+            count=page.meta.count,
         )
-        return data, meta
+        return page.data, meta
 
     async def get(
         self,

services/catalog/src/simcore_service_catalog/api/rpc/_services.py

@@ -5,14 +5,14 @@
 from fastapi import FastAPI
 from models_library.api_schemas_catalog.services import (
     MyServiceGet,
-    PageRpcServicesGetV2,
+    PageRpcLatestServiceGet,
+    PageRpcServiceRelease,
     ServiceGetV2,
     ServiceUpdateV2,
 )
 from models_library.products import ProductName
 from models_library.rest_pagination import PageOffsetInt
 from models_library.rpc_pagination import DEFAULT_NUMBER_OF_ITEMS_PER_PAGE, PageLimitInt
-from models_library.services_history import ServiceRelease
 from models_library.services_types import ServiceKey, ServiceVersion
 from models_library.users import UserID
 from pydantic import ValidationError, validate_call
@@ -65,7 +65,7 @@ async def list_services_paginated(
     user_id: UserID,
     limit: PageLimitInt = DEFAULT_NUMBER_OF_ITEMS_PER_PAGE,
     offset: PageOffsetInt = 0,
-) -> PageRpcServicesGetV2:
+) -> PageRpcLatestServiceGet:
     assert app.state.engine  # nosec
 
     total_count, items = await services_api.list_latest_services(
@@ -81,8 +81,8 @@ async def list_services_paginated(
     assert len(items) <= limit  # nosec
 
     return cast(
-        PageRpcServicesGetV2,
-        PageRpcServicesGetV2.create(
+        PageRpcLatestServiceGet,
+        PageRpcLatestServiceGet.create(
             items,
             total=total_count,
             limit=limit,
@@ -232,10 +232,12 @@ async def get_my_service_history(
     product_name: ProductName,
     user_id: UserID,
     service_key: ServiceKey,
-) -> list[ServiceRelease]:
+    limit: PageLimitInt = DEFAULT_NUMBER_OF_ITEMS_PER_PAGE,
+    offset: PageOffsetInt = 0,
+) -> PageRpcServiceRelease:
     assert app.state.engine  # nosec
 
-    return await services_api.get_service_history(
+    history = await services_api.get_service_history(
         repo=ServicesRepository(app.state.engine),
         product_name=product_name,
         user_id=user_id,