✨ Expose /licensed-items endpoint in api server (#6958)

Co-authored-by: matusdrobuliak66 <[email protected]>
Co-authored-by: Matus Drobuliak <[email protected]>

Author: bisgaard-itis

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

@@ -3,7 +3,7 @@
 
 from models_library.licensed_items import LicensedItemID, LicensedResourceType
 from models_library.resource_tracker import PricingPlanId
-from pydantic import PositiveInt
+from pydantic import ConfigDict, PositiveInt
 
 from ._base import OutputSchema
 
@@ -15,6 +15,20 @@ class LicensedItemGet(OutputSchema):
     pricing_plan_id: PricingPlanId
     created_at: datetime
     modified_at: datetime
+    model_config = ConfigDict(
+        json_schema_extra={
+            "examples": [
+                {
+                    "licensed_item_id": "0362b88b-91f8-4b41-867c-35544ad1f7a1",
+                    "name": "best-model",
+                    "licensed_resource_type": f"{LicensedResourceType.VIP_MODEL}",
+                    "pricing_plan_id": "15",
+                    "created_at": "2024-12-12 09:59:26.422140",
+                    "modified_at": "2024-12-12 09:59:26.422140",
+                }
+            ]
+        }
+    )
 
 
 class LicensedItemGetPage(NamedTuple):

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

@@ -6,15 +6,23 @@
 from servicelib.aiohttp.application_setup import ApplicationSetupError
 from servicelib.fastapi.dependencies import get_app
 from servicelib.rabbitmq import RabbitMQClient
+from servicelib.rabbitmq._client_rpc import RabbitMQRPCClient
 from tenacity import before_sleep_log, retry, stop_after_delay, wait_fixed
 
-from ...services.log_streaming import LogDistributor
+from ...services_http.log_streaming import LogDistributor
 
 _MAX_WAIT_FOR_LOG_DISTRIBUTOR_SECONDS: Final[int] = 10
 
 _logger = logging.getLogger(__name__)
 
 
+def get_rabbitmq_rpc_client(
+    app: Annotated[FastAPI, Depends(get_app)]
+) -> RabbitMQRPCClient:
+    assert app.state.rabbitmq_rpc_client  # nosec
+    return cast(RabbitMQRPCClient, app.state.rabbitmq_rpc_client)
+
+
 def get_rabbitmq_client(app: Annotated[FastAPI, Depends(get_app)]) -> RabbitMQClient:
     assert app.state.rabbitmq_client  # nosec
     return cast(RabbitMQClient, app.state.rabbitmq_client)

services/api-server/src/simcore_service_api_server/api/dependencies/webserver.py renamed to services/api-server/src/simcore_service_api_server/api/dependencies/webserver_http.py

@@ -9,7 +9,7 @@
 
 from ..._constants import MSG_BACKEND_SERVICE_UNAVAILABLE
 from ...core.settings import ApplicationSettings, WebServerSettings
-from ...services.webserver import AuthSession
+from ...services_http.webserver import AuthSession
 from .application import get_app, get_settings
 from .authentication import Identity, get_active_user_email, get_current_identity
 

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

@@ -0,0 +1,13 @@
+from typing import Annotated, cast
+
+from fastapi import Depends, FastAPI
+from servicelib.fastapi.dependencies import get_app
+
+from ...services_rpc.wb_api_server import WbApiRpcClient
+
+
+async def get_wb_api_rpc_client(
+    app: Annotated[FastAPI, Depends(get_app)]
+) -> WbApiRpcClient:
+    assert app.state.wb_api_rpc_client  # nosec
+    return cast(WbApiRpcClient, app.state.wb_api_rpc_client)

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

@@ -7,6 +7,7 @@
 from .routes import (
     files,
     health,
+    licensed_items,
     meta,
     solvers,
     solvers_jobs,
@@ -40,6 +41,9 @@ def create_router(settings: ApplicationSettings):
     router.include_router(studies_jobs.router, tags=["studies"], prefix="/studies")
     router.include_router(wallets.router, tags=["wallets"], prefix="/wallets")
     router.include_router(_credits.router, tags=["credits"], prefix="/credits")
+    router.include_router(
+        licensed_items.router, tags=["licensed-items"], prefix="/licensed-items"
+    )
 
     # NOTE: multiple-files upload is currently disabled
     # Web form to upload files at http://localhost:8000/v0/upload-form-view

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

@@ -3,7 +3,7 @@
 from fastapi import APIRouter, Depends, status
 
 from ...models.schemas.model_adapter import GetCreditPriceLegacy
-from ..dependencies.webserver import AuthSession, get_webserver_session
+from ..dependencies.webserver_http import AuthSession, get_webserver_session
 from ._constants import FMSG_CHANGELOG_NEW_IN_VERSION
 
 router = APIRouter()

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

@@ -37,7 +37,7 @@
     FileUploadData,
     UploadLinks,
 )
-from ...services.storage import StorageApi, StorageFileMetaData, to_file_api_model
+from ...services_http.storage import StorageApi, StorageFileMetaData, to_file_api_model
 from ..dependencies.authentication import get_current_user_id
 from ..dependencies.services import get_api_client
 from ._common import API_SERVER_DEV_FEATURES_ENABLED

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

@@ -10,10 +10,10 @@
 
 from ..._meta import API_VERSION, PROJECT_NAME
 from ...core.health_checker import ApiServerHealthChecker, get_health_checker
-from ...services.catalog import CatalogApi
-from ...services.director_v2 import DirectorV2Api
-from ...services.storage import StorageApi
-from ...services.webserver import WebserverApi
+from ...services_http.catalog import CatalogApi
+from ...services_http.director_v2 import DirectorV2Api
+from ...services_http.storage import StorageApi
+from ...services_http.webserver import WebserverApi
 from ..dependencies.application import get_reverse_url_mapper
 from ..dependencies.services import get_api_client
 

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

@@ -0,0 +1,34 @@
+from typing import Annotated, Any
+
+from fastapi import APIRouter, Depends, status
+
+from ...api.dependencies.authentication import get_product_name
+from ...api.dependencies.webserver_rpc import get_wb_api_rpc_client
+from ...exceptions.service_errors_utils import DEFAULT_BACKEND_SERVICE_STATUS_CODES
+from ...models.pagination import Page, PaginationParams
+from ...models.schemas.model_adapter import LicensedItemGet
+from ...services_rpc.wb_api_server import WbApiRpcClient
+
+router = APIRouter()
+
+_LICENSE_ITEMS_STATUS_CODES: dict[int | str, dict[str, Any]] = {
+    **DEFAULT_BACKEND_SERVICE_STATUS_CODES,
+}
+
+
+@router.get(
+    "",
+    response_model=Page[LicensedItemGet],
+    status_code=status.HTTP_200_OK,
+    responses=_LICENSE_ITEMS_STATUS_CODES,
+    description="Get all licensed items",
+    include_in_schema=False,
+)
+async def get_licensed_items(
+    page_params: Annotated[PaginationParams, Depends()],
+    web_api_rpc: Annotated[WbApiRpcClient, Depends(get_wb_api_rpc_client)],
+    product_name: Annotated[str, Depends(get_product_name)],
+):
+    return await web_api_rpc.get_licensed_items(
+        product_name=product_name, page_params=page_params
+    )

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

@@ -13,11 +13,11 @@
 from ...models.schemas.errors import ErrorGet
 from ...models.schemas.model_adapter import ServicePricingPlanGetLegacy
 from ...models.schemas.solvers import Solver, SolverKeyId, SolverPort
-from ...services.catalog import CatalogApi
+from ...services_http.catalog import CatalogApi
 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
-from ..dependencies.webserver import AuthSession, get_webserver_session
+from ..dependencies.webserver_http import AuthSession, get_webserver_session
 from ._common import API_SERVER_DEV_FEATURES_ENABLED
 from ._constants import FMSG_CHANGELOG_NEW_IN_VERSION