fix: refactoring

Author: giancarloromeo

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

@@ -1,5 +1,5 @@
 from pathlib import Path
-from typing import Annotated
+from typing import Annotated, Final
 
 from models_library.utils.common_validators import (
     MIN_NON_WILDCARD_CHARS,
@@ -16,6 +16,9 @@
 from ..rest_pagination import CursorQueryParameters
 from ._base import InputSchema
 
+MAX_SEARCH_ITEMS_PER_PAGE: Final[int] = 25
+DEFAULT_MAX_SEARCH_ITEMS_PER_PAGE: Final[int] = 50
+
 
 class StorageLocationPathParams(BaseModel):
     location_id: LocationID
@@ -57,11 +60,11 @@ class SearchBodyParams(InputSchema):
             description=f"Name pattern with wildcard support {tuple(WILDCARD_CHARS)}. Minimum of {MIN_NON_WILDCARD_CHARS} non-wildcard characters required.",
         ),
     ]
-    items_per_page: Annotated[
+    max_items_per_page: Annotated[
         int,
         Field(
-            description="Number of items per page",
+            description="Max number of items per page",
             ge=1,
-            le=MAX_NUMBER_OF_PATHS_PER_PAGE,
+            le=MAX_SEARCH_ITEMS_PER_PAGE,
         ),
-    ] = DEFAULT_NUMBER_OF_PATHS_PER_PAGE
+    ] = DEFAULT_MAX_SEARCH_ITEMS_PER_PAGE

packages/service-library/src/servicelib/rabbitmq/rpc_interfaces/storage/simcore_s3.py

@@ -52,14 +52,14 @@ async def start_search(
     *,
     job_filter: AsyncJobFilter,
     name_pattern: str,
-    items_per_page: int,
+    max_items_per_page: int,
 ) -> tuple[AsyncJobGet, AsyncJobFilter]:
     async_job_rpc_get = await submit(
         rabbitmq_rpc_client,
         rpc_namespace=STORAGE_RPC_NAMESPACE,
         method_name=TypeAdapter(RPCMethodName).validate_python("start_search"),
         job_filter=job_filter,
         name_pattern=name_pattern,
-        items_per_page=items_per_page,
+        max_items_per_page=max_items_per_page,
     )
     return async_job_rpc_get, job_filter

packages/service-library/src/servicelib/sse/__init__.py

@@ -1,6 +1,16 @@
 from typing import Annotated
 
-from pydantic import BaseModel, BeforeValidator
+from pydantic import BaseModel, BeforeValidator, Field
+
+
+class SSEHeaders(BaseModel):
+    last_event_id: Annotated[
+        str | None,
+        Field(
+            description="Optional last event ID",
+            alias="Last-Event-ID",
+        ),
+    ] = None
 
 
 def _normalize_data(v: str | list[str]) -> list[str]:

…es/service-library/src/servicelib/sse.py …ice-library/src/servicelib/sse/models.pypackages/service-library/src/servicelib/sse.py renamed to packages/service-library/src/servicelib/sse/models.py packages/service-library/src/servicelib/sse.py renamed to packages/service-library/src/servicelib/sse/models.py

@@ -139,7 +139,7 @@ async def search(
     user_id: UserID,
     project_id: ProjectID | None,
     name_pattern: str,
-    items_per_page: int,
+    max_items_per_page: int,
 ) -> None:
     with log_context(
         _logger,
@@ -157,7 +157,7 @@ async def search(
             user_id=user_id,
             project_id=project_id,
             name_pattern=name_pattern,
-            items_per_page=items_per_page,
+            items_per_page=max_items_per_page,
         ):
             data = [
                 SearchResult(

services/storage/src/simcore_service_storage/api/_worker_tasks/_simcore_s3.py

@@ -72,7 +72,7 @@ async def start_search(
     task_manager: TaskManager,
     job_filter: AsyncJobFilter,
     name_pattern: str,
-    items_per_page: int,
+    max_items_per_page: int,
     project_id: str | None = None,
 ) -> AsyncJobGet:
     task_name = search.__name__
@@ -85,6 +85,6 @@ async def start_search(
         user_id=job_filter.user_id,
         project_id=project_id,
         name_pattern=name_pattern,
-        items_per_page=items_per_page,
+        max_items_per_page=max_items_per_page,
     )
     return AsyncJobGet(job_id=task_uuid, job_name=task_name)

services/storage/src/simcore_service_storage/api/rpc/_simcore_s3.py

@@ -67,9 +67,8 @@
 )
 from servicelib.request_keys import RQT_USERID_KEY
 from servicelib.rest_responses import unwrap_envelope
-from servicelib.sse import SSEEvent
+from servicelib.sse.models import SSEEvent, SSEHeaders
 from simcore_service_webserver.celery import get_task_manager
-from simcore_service_webserver.storage._rest_schemas import StreamHeaders
 from yarl import URL
 
 from .._meta import API_VTAG
@@ -571,7 +570,7 @@ class _PathParams(BaseModel):
             product_name=_req_ctx.product_name,
         ),
         name_pattern=search_body.name_pattern,
-        items_per_page=search_body.items_per_page,
+        max_items_per_page=search_body.max_items_per_page,
     )
     _job_id = f"{async_job_rpc_get.job_id}"
     return create_data_response(
@@ -599,7 +598,7 @@ class _PathParams(BaseModel):
 
     _req_ctx = AuthenticatedRequestContext.model_validate(request)
     path_params = parse_request_path_parameters_as(_PathParams, request)
-    header_params = parse_request_headers_as(StreamHeaders, request)
+    header_params = parse_request_headers_as(SSEHeaders, request)
 
     task_manager = get_task_manager(request.app)
     task_filter = get_job_filter(