✨ Implementing new list_services_paginated entrypoint in web-api (part 1) (#5991)

Author: pcrespov

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

@@ -1,11 +1,11 @@
-from typing import Any, ClassVar
+from typing import Any, ClassVar, TypeAlias
 
 from models_library.rpc_pagination import PageRpc
 from pydantic import BaseModel, Extra, Field, HttpUrl, NonNegativeInt
 
 from ..boot_options import BootOptions
 from ..emails import LowerCaseEmailStr
-from ..services_access import ServiceAccessRights, ServiceGroupAccessRightsApi
+from ..services_access import ServiceAccessRights
 from ..services_authoring import Author, Badge
 from ..services_enums import ServiceType
 from ..services_history import ServiceRelease
@@ -205,6 +205,15 @@ class Config:
         }
 
 
+class ServiceGroupAccessRightsV2(BaseModel):
+    execute: bool = False
+    write: bool = False
+
+    class Config:
+        alias_generator = snake_to_camel
+        allow_population_by_field_name = True
+
+
 class ServiceGetV2(BaseModel):
     key: ServiceKey
     version: ServiceVersion
@@ -229,9 +238,9 @@ class ServiceGetV2(BaseModel):
     boot_options: BootOptions | None = None
     min_visible_inputs: NonNegativeInt | None = None
 
-    access_rights: dict[GroupID, ServiceGroupAccessRightsApi] | None
+    access_rights: dict[GroupID, ServiceGroupAccessRightsV2] | None
 
-    classifiers: list[str] | None
+    classifiers: list[str] | None = None
     quality: dict[str, Any] = {}
 
     history: list[ServiceRelease] = Field(
@@ -298,9 +307,9 @@ class Config:
         }
 
 
-PageRpcServicesGetV2 = PageRpc[
+PageRpcServicesGetV2: TypeAlias = PageRpc[
     # WARNING: keep this definition in models_library and not in the RPC interface
     ServiceGetV2
 ]
 
-ServiceResourcesGet = ServiceResourcesDict
+ServiceResourcesGet: TypeAlias = ServiceResourcesDict

packages/models-library/src/models_library/services_access.py

@@ -6,7 +6,6 @@
 from pydantic import BaseModel, Field
 
 from .users import GroupID
-from .utils.change_case import snake_to_camel
 
 
 class ServiceGroupAccessRights(BaseModel):
@@ -19,12 +18,6 @@ class ServiceGroupAccessRights(BaseModel):
     )
 
 
-class ServiceGroupAccessRightsApi(ServiceGroupAccessRights):
-    class Config:
-        alias_generator = snake_to_camel
-        allow_population_by_field_name = True
-
-
 class ServiceAccessRights(BaseModel):
     access_rights: dict[GroupID, ServiceGroupAccessRights] | None = Field(
         None,

packages/models-library/src/models_library/services_authoring.py

@@ -1,3 +1,5 @@
+from typing import Any, ClassVar
+
 from pydantic import BaseModel, Field, HttpUrl
 
 from .emails import LowerCaseEmailStr
@@ -7,35 +9,48 @@ class Badge(BaseModel):
     name: str = Field(
         ...,
         description="Name of the subject",
-        examples=["travis-ci", "coverals.io", "github.io"],
     )
     image: HttpUrl = Field(
         ...,
         description="Url to the badge",
-        examples=[
-            "https://travis-ci.org/ITISFoundation/osparc-simcore.svg?branch=master",
-            "https://coveralls.io/repos/github/ITISFoundation/osparc-simcore/badge.svg?branch=master",
-            "https://img.shields.io/website-up-down-green-red/https/itisfoundation.github.io.svg?label=documentation",
-        ],
     )
     url: HttpUrl = Field(
         ...,
         description="Link to the status",
-        examples=[
-            "https://travis-ci.org/ITISFoundation/osparc-simcore 'State of CI: build, test and pushing images'",
-            "https://coveralls.io/github/ITISFoundation/osparc-simcore?branch=master 'Test coverage'",
-            "https://itisfoundation.github.io/",
-        ],
     )
 
+    class Config:
+        schema_extra: ClassVar[dict[str, Any]] = {
+            "example": {
+                "name": "osparc.io",
+                "image": "https://img.shields.io/website-up-down-green-red/https/itisfoundation.github.io.svg?label=documentation",
+                "url": "https://itisfoundation.github.io/",
+            }
+        }
+
 
 class Author(BaseModel):
-    name: str = Field(..., description="Name of the author", example="Jim Knopf")
+    name: str = Field(
+        ...,
+        description="Name of the author",
+    )
     email: LowerCaseEmailStr = Field(
         ...,
-        examples=["[email protected]", "[email protected]"],
         description="Email address",
     )
-    affiliation: str | None = Field(
-        None, examples=["Sense8", "Babylon 5"], description="Affiliation of the author"
-    )
+    affiliation: str | None = Field(None)
+
+    class Config:
+        schema_extra: ClassVar[dict[str, Any]] = {
+            "examples": [
+                {
+                    "name": "Jim Knopf",
+                    "email": "[email protected]",
+                    "affiliation": "Babylon 5",
+                },
+                {
+                    "name": "John Smith",
+                    "email": "[email protected]",
+                },
+            ]
+        }

packages/models-library/src/models_library/services_history.py

@@ -23,7 +23,9 @@ class Config:
 class ServiceRelease(BaseModel):
     # from ServiceMetaDataPublished
     version: ServiceVersion
-    version_display: str | None = Field(default=None)
+    version_display: str | None = Field(
+        default=None, description="If None, then display `version`"
+    )
     released: datetime | None = Field(
         default=None, description="When provided, it indicates the release timestamp"
     )

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

@@ -32,6 +32,12 @@ async def list_services_paginated(  # pylint: disable=too-many-arguments
     limit: PageLimitInt = DEFAULT_NUMBER_OF_ITEMS_PER_PAGE,
     offset: NonNegativeInt = 0,
 ) -> PageRpc[ServiceGetV2]:
+    """
+    Raises:
+        ValidationError: on invalid arguments
+
+    """
+
     @validate_arguments()
     async def _call(
         product_name: ProductName,
@@ -64,6 +70,12 @@ async def get_service(
     service_key: ServiceKey,
     service_version: ServiceVersion,
 ) -> ServiceGetV2:
+    """
+    Raises:
+        ValidationError: on invalid arguments
+
+    """
+
     @validate_arguments()
     async def _call(
         product_name: ProductName,
@@ -100,7 +112,11 @@ async def update_service(
     service_version: ServiceVersion,
     update: ServiceUpdate,
 ) -> ServiceGetV2:
-    """Updates editable fields of a service"""
+    """Updates editable fields of a service
+
+    Raises:
+        ValidationError: on invalid arguments
+    """
 
     @validate_arguments()
     async def _call(

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

@@ -9,14 +9,14 @@
 from fastapi import APIRouter, Depends, Header, HTTPException, status
 from models_library.api_schemas_catalog.services import ServiceGet, ServiceUpdate
 from models_library.services import ServiceKey, ServiceType, ServiceVersion
-from models_library.services_db import ServiceAccessRightsAtDB, ServiceMetaDataAtDB
 from pydantic import ValidationError
 from pydantic.types import PositiveInt
 from servicelib.fastapi.requests_decorators import cancel_on_disconnect
 from starlette.requests import Request
 
 from ...db.repositories.groups import GroupsRepository
 from ...db.repositories.services import ServicesRepository
+from ...models.services_db import ServiceAccessRightsAtDB, ServiceMetaDataAtDB
 from ...services.director import DirectorApi
 from ...services.function_services import is_function_service
 from ..dependencies.database import get_repository

services/catalog/src/simcore_service_catalog/api/rest/_services_access_rights.py

@@ -6,9 +6,9 @@
     ServiceAccessRightsGet,
 )
 from models_library.services import ServiceKey, ServiceVersion
-from models_library.services_db import ServiceAccessRightsAtDB
 
 from ...db.repositories.services import ServicesRepository
+from ...models.services_db import ServiceAccessRightsAtDB
 from ..dependencies.database import get_repository
 from ..dependencies.services import AccessInfo, check_service_read_access
 from ._constants import RESPONSE_MODEL_POLICY

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

@@ -14,6 +14,9 @@
 from servicelib.logging_utils import log_decorator
 from servicelib.rabbitmq import RPCRouter
 
+from ...db.repositories.services import ServicesRepository
+from ...services import catalog
+
 _logger = logging.getLogger(__name__)
 
 router = RPCRouter()
@@ -29,17 +32,21 @@ async def list_services_paginated(
     limit: PageLimitInt = DEFAULT_NUMBER_OF_ITEMS_PER_PAGE,
     offset: NonNegativeInt = 0,
 ) -> PageRpcServicesGetV2:
-    assert app  # nosec
-    assert product_name  # nosec
+    assert app.state.engine  # nosec
 
-    _logger.debug("Moking list_services_paginated for %s...", f"{user_id=}")
-    items = parse_obj_as(
-        list[ServiceGetV2], ServiceGetV2.Config.schema_extra["examples"]
+    total_count, items = await catalog.list_services_paginated(
+        repo=ServicesRepository(app.state.engine),
+        product_name=product_name,
+        user_id=user_id,
+        limit=limit,
+        offset=offset,
     )
-    total_count = len(items)
+
+    assert len(items) <= total_count  # nosec
+    assert len(items) <= limit  # nosec
 
     return PageRpcServicesGetV2.create(
-        items[offset : offset + limit],
+        items,
         total=total_count,
         limit=limit,
         offset=offset,

services/catalog/src/simcore_service_catalog/core/background_tasks.py

@@ -18,7 +18,6 @@
 from fastapi import FastAPI
 from models_library.function_services_catalog.api import iter_service_docker_data
 from models_library.services import ServiceMetaDataPublished
-from models_library.services_db import ServiceAccessRightsAtDB, ServiceMetaDataAtDB
 from packaging.version import Version
 from pydantic import ValidationError
 from sqlalchemy.ext.asyncio import AsyncEngine
@@ -27,6 +26,7 @@
 from ..db.repositories.groups import GroupsRepository
 from ..db.repositories.projects import ProjectsRepository
 from ..db.repositories.services import ServicesRepository
+from ..models.services_db import ServiceAccessRightsAtDB, ServiceMetaDataAtDB
 from ..services import access_rights
 
 _logger = logging.getLogger(__name__)
@@ -120,10 +120,9 @@ def _by_version(t: tuple[ServiceKey, ServiceVersion]) -> Version:
             service_access_rights
         )
 
-        service_metadata_dict = service_metadata.dict()
         # set the service in the DB
-        await services_repo.create_service(
-            ServiceMetaDataAtDB(**service_metadata_dict, owner=owner_gid),
+        await services_repo.create_or_update_service(
+            ServiceMetaDataAtDB(**service_metadata.dict(), owner=owner_gid),
             service_access_rights,
         )