daily work

Author: matusdrobuliak66

api/specs/web-server/_licensed_items.py

@@ -10,9 +10,10 @@
 
 from _common import as_query
 from fastapi import APIRouter, Depends, status
-from models_library.api_schemas_webserver.licensed_items import LicensedItemGet
+from models_library.api_schemas_webserver.licensed_items import LicensedItemRestGet
 from models_library.generics import Envelope
 from models_library.rest_error import EnvelopedError
+from models_library.rest_pagination import Page
 from simcore_service_webserver._meta import API_VTAG
 from simcore_service_webserver.licenses._common.exceptions_handlers import (
     _TO_HTTP_ERROR_MAP,
@@ -37,7 +38,7 @@
 
 @router.get(
     "/catalog/licensed-items",
-    response_model=Envelope[list[LicensedItemGet]],
+    response_model=Page[LicensedItemRestGet],
 )
 async def list_licensed_items(
     _query: Annotated[as_query(LicensedItemsListQueryParams), Depends()],
@@ -47,7 +48,7 @@ async def list_licensed_items(
 
 @router.get(
     "/catalog/licensed-items/{licensed_item_id}",
-    response_model=Envelope[LicensedItemGet],
+    response_model=Envelope[LicensedItemRestGet],
 )
 async def get_licensed_item(
     _path: Annotated[LicensedItemsPathParams, Depends()],

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

@@ -1,30 +1,85 @@
 from datetime import datetime
 from typing import NamedTuple
 
-from models_library.licensed_items import LicensedItemID, LicensedResourceType
+from models_library.licensed_items import (
+    LicensedItemID,
+    LicensedResourceType,
+    VipDetails,
+)
 from models_library.resource_tracker import PricingPlanId
-from pydantic import ConfigDict, PositiveInt
+from pydantic import BaseModel, ConfigDict, PositiveInt
+from pydantic.alias_generators import to_camel
 
 from ._base import OutputSchema
 
+# RPC
 
-class LicensedItemGet(OutputSchema):
+
+class LicensedItemRpcGet(BaseModel):
+    licensed_item_id: LicensedItemID
+    display_name: str
+    licensed_resource_type: LicensedResourceType
+    pricing_plan_id: PricingPlanId
+    licensed_resource_type_details: VipDetails
+    created_at: datetime
+    modified_at: datetime
+    model_config = ConfigDict(
+        json_schema_extra={
+            "examples": [
+                {
+                    "licensed_item_id": "0362b88b-91f8-4b41-867c-35544ad1f7a1",
+                    "display_name": "best-model",
+                    "licensed_resource_type": f"{LicensedResourceType.VIP_MODEL}",
+                    "pricing_plan_id": "15",
+                    "licensed_resource_type_details": VipDetails.model_config[
+                        "json_schema_extra"
+                    ]["examples"][0],
+                    "created_at": "2024-12-12 09:59:26.422140",
+                    "modified_at": "2024-12-12 09:59:26.422140",
+                }
+            ]
+        }
+    )
+
+
+class LicensedItemRpcGetPage(NamedTuple):
+    items: list[LicensedItemRpcGet]
+    total: PositiveInt
+
+
+# Rest
+class CustomBaseModel(BaseModel):
+    model_config = ConfigDict(
+        alias_generator=to_camel, populate_by_name=True, extra="allow"
+    )
+
+    def model_dump_camel(self):
+        data = self.model_dump(by_alias=True)
+        if hasattr(self, "__pydantic_extra__") and self.__pydantic_extra__:
+            extra_camel = {to_camel(k): v for k, v in self.__pydantic_extra__.items()}
+            data.update(extra_camel)
+        return data
+
+
+class LicensedItemRestGet(OutputSchema):
     licensed_item_id: LicensedItemID
-    name: str
-    license_key: str | None
+    display_name: str
     licensed_resource_type: LicensedResourceType
     pricing_plan_id: PricingPlanId
+    licensed_resource_type_details: VipDetails
     created_at: datetime
     modified_at: datetime
     model_config = ConfigDict(
         json_schema_extra={
             "examples": [
                 {
                     "licensed_item_id": "0362b88b-91f8-4b41-867c-35544ad1f7a1",
-                    "name": "best-model",
-                    "license_key": "license-specific-key",
+                    "display_name": "best-model",
                     "licensed_resource_type": f"{LicensedResourceType.VIP_MODEL}",
                     "pricing_plan_id": "15",
+                    "licensed_resource_type_details": VipDetails.model_config[
+                        "json_schema_extra"
+                    ]["examples"][0],
                     "created_at": "2024-12-12 09:59:26.422140",
                     "modified_at": "2024-12-12 09:59:26.422140",
                 }
@@ -33,6 +88,6 @@ class LicensedItemGet(OutputSchema):
     )
 
 
-class LicensedItemGetPage(NamedTuple):
-    items: list[LicensedItemGet]
+class LicensedItemRestGetPage(NamedTuple):
+    items: list[LicensedItemRestGet]
     total: PositiveInt

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

@@ -3,7 +3,8 @@
 from typing import TypeAlias
 from uuid import UUID
 
-from pydantic import BaseModel, ConfigDict, Field
+from pydantic import AliasGenerator, BaseModel, ConfigDict, Field
+from pydantic.alias_generators import to_camel
 
 from .products import ProductName
 from .resource_tracker import PricingPlanId
@@ -16,18 +17,92 @@ class LicensedResourceType(StrAutoEnum):
     VIP_MODEL = auto()
 
 
+class VipFeatures(BaseModel):
+    name: str
+    version: str
+    sex: str
+    age: str
+    weight: str
+    height: str
+    data: str
+    ethnicity: str
+    functionality: str
+
+    model_config = ConfigDict(
+        alias_generator=AliasGenerator(
+            serialization_alias=to_camel,
+        ),
+        populate_by_name=True,
+        extra="allow",
+        json_schema_extra={
+            "examples": [
+                {
+                    "name": "Duke",
+                    "version": "V2.0",
+                    "sex": "Male",
+                    "age": "34 years",
+                    "weight": "70.2 Kg",
+                    "height": "1.77 m",
+                    "data": "2015-03-01",
+                    "ethnicity": "Caucasian",
+                    "functionality": "Static",
+                    "additional_field": "allowed",
+                }
+            ]
+        },
+    )
+
+
+class VipDetails(BaseModel):
+    id: int
+    description: str
+    thumbnail: str
+    features: VipFeatures
+    doi: str
+    license_key: str | None
+    license_version: str | None
+    protection: str
+    available_from_url: str
+
+    model_config = ConfigDict(
+        alias_generator=AliasGenerator(
+            serialization_alias=to_camel,
+        ),
+        populate_by_name=True,
+        extra="allow",
+        json_schema_extra={
+            "examples": [
+                {
+                    "id": 1,
+                    "description": "custom description",
+                    "thumbnail": "custom description",
+                    "features": VipFeatures.model_config["json_schema_extra"][
+                        "examples"
+                    ][0],
+                    "doi": "custom value",
+                    "license_key": "custom value",
+                    "license_version": "custom value",
+                    "protection": "custom value",
+                    "available_from_url": "custom value",
+                    "additional_field": "allowed",
+                }
+            ]
+        },
+    )
+
+
 #
 # DB
 #
 
 
 class LicensedItemDB(BaseModel):
     licensed_item_id: LicensedItemID
-    name: str
-    license_key: str | None
+    display_name: str
     licensed_resource_type: LicensedResourceType
     pricing_plan_id: PricingPlanId
     product_name: ProductName
+    licensed_resource_type_details: VipDetails
     created: datetime = Field(
         ...,
         description="Timestamp on creation",
@@ -41,5 +116,5 @@ class LicensedItemDB(BaseModel):
 
 
 class LicensedItemUpdateDB(BaseModel):
-    name: str | None = None
+    display_name: str | None = None
     pricing_plan_id: PricingPlanId | None = None

packages/postgres-database/src/simcore_postgres_database/migration/versions/7bde20ddf18e_modify_licensed_items_db.py

@@ -0,0 +1,50 @@
+"""modify licensed items DB
+
+Revision ID: 7bde20ddf18e
+Revises: 1bc517536e0a
+Create Date: 2025-01-29 12:34:18.162155+00:00
+
+"""
+import sqlalchemy as sa
+from alembic import op
+from sqlalchemy.dialects import postgresql
+
+# revision identifiers, used by Alembic.
+revision = "7bde20ddf18e"
+down_revision = "1bc517536e0a"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column(
+        "licensed_items", sa.Column("display_name", sa.String(), nullable=False)
+    )
+    op.add_column(
+        "licensed_items",
+        sa.Column(
+            "licensed_resource_type_details",
+            postgresql.JSONB(astext_type=sa.Text()),
+            server_default=sa.text("'{}'::jsonb"),
+            nullable=False,
+        ),
+    )
+    op.drop_column("licensed_items", "name")
+    op.drop_column("licensed_items", "license_key")
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column(
+        "licensed_items",
+        sa.Column("license_key", sa.VARCHAR(), autoincrement=False, nullable=True),
+    )
+    op.add_column(
+        "licensed_items",
+        sa.Column("name", sa.VARCHAR(), autoincrement=False, nullable=False),
+    )
+    op.drop_column("licensed_items", "licensed_resource_type_details")
+    op.drop_column("licensed_items", "display_name")
+    # ### end Alembic commands ###

packages/postgres-database/src/simcore_postgres_database/models/licensed_items.py

@@ -4,7 +4,7 @@
 import enum
 
 import sqlalchemy as sa
-from sqlalchemy.dialects.postgresql import UUID
+from sqlalchemy.dialects.postgresql import JSONB, UUID
 
 from ._common import RefActions, column_created_datetime, column_modified_datetime
 from .base import metadata
@@ -25,7 +25,7 @@ class LicensedResourceType(str, enum.Enum):
         server_default=sa.text("gen_random_uuid()"),
     ),
     sa.Column(
-        "name",
+        "display_name",
         sa.String,
         nullable=False,
     ),
@@ -59,10 +59,10 @@ class LicensedResourceType(str, enum.Enum):
         doc="Product name",
     ),
     sa.Column(
-        "license_key",
-        sa.String,
-        nullable=True,
-        doc="Purpose: Acts as a mapping key to the internal license server. Usage: The Sim4Life base applications use this key to check out a seat from the internal license server.",
+        "licensed_resource_type_details",
+        JSONB,
+        nullable=False,
+        server_default=sa.text("'{}'::jsonb"),
     ),
     column_created_datetime(timezone=True),
     column_modified_datetime(timezone=True),

packages/postgres-database/tests/licensed_items/conftest.py

@@ -0,0 +1,63 @@
+# pylint: disable=no-name-in-module
+# pylint: disable=no-value-for-parameter
+# pylint: disable=redefined-outer-name
+# pylint: disable=unused-argument
+
+
+from collections.abc import Callable
+
+import pytest
+from aiopg.sa.exc import ResourceClosedError
+from faker import Faker
+from pytest_simcore.helpers.faker_factories import random_product
+from simcore_postgres_database.webserver_models import products
+from sqlalchemy.dialects.postgresql import insert as pg_insert
+
+
+@pytest.fixture
+def products_regex() -> dict:
+    return {
+        "s4l": r"(^s4l[\.-])|(^sim4life\.)",
+        "osparc": r"^osparc.",
+        "tis": r"(^ti.[\.-])|(^ti-solution\.)",
+    }
+
+
+@pytest.fixture
+def products_names(products_regex: dict) -> list[str]:
+    return list(products_regex)
+
+
+@pytest.fixture
+def make_products_table(products_regex: dict, faker: Faker) -> Callable:
+    async def _make(conn) -> None:
+        for n, (name, regex) in enumerate(products_regex.items()):
+
+            result = await conn.execute(
+                pg_insert(products)
+                .values(
+                    **random_product(
+                        name=name,
+                        display_name=f"Product {name.capitalize()}",
+                        short_name=name[:3].lower(),
+                        host_regex=regex,
+                        priority=n,
+                    )
+                )
+                .on_conflict_do_update(
+                    index_elements=[products.c.name],
+                    set_={
+                        "display_name": f"Product {name.capitalize()}",
+                        "short_name": name[:3].lower(),
+                        "host_regex": regex,
+                        "priority": n,
+                    },
+                )
+            )
+
+            assert result.closed
+            assert not result.returns_rows
+            with pytest.raises(ResourceClosedError):
+                await result.scalar()
+
+    return _make