✨ Sync task that auto-registers items from VIP as licensed items in the system 🗃️ 🚨 (#7140)

Author: pcrespov

.env-devel

@@ -133,6 +133,11 @@ DYNAMIC_SCHEDULER_UI_STORAGE_SECRET=adminadmin
 
 FUNCTION_SERVICES_AUTHORS='{"UN": {"name": "Unknown", "email": "[email protected]", "affiliation": "unknown"}}'
 
+WEBSERVER_LICENSES={}
+LICENSES_ITIS_VIP_SYNCER_ENABLED=false
+LICENSES_ITIS_VIP_API_URL=https://some-api/{category}
+LICENSES_ITIS_VIP_CATEGORIES='{"HumanWholeBody": "Humans", "HumanBodyRegion": "Humans (Region)", "AnimalWholeBody": "Animal"}'
+
 # Can use 'docker run -it itisfoundation/invitations:latest simcore-service-invitations generate-dotenv --auto-password'
 INVITATIONS_DEFAULT_PRODUCT=osparc
 INVITATIONS_HOST=invitations
@@ -371,7 +376,6 @@ WEBSERVER_GARBAGE_COLLECTOR=null
 WEBSERVER_GROUPS=1
 WEBSERVER_GUNICORN_CMD_ARGS=--timeout=180
 WEBSERVER_HOST=webserver
-WEBSERVER_LICENSES=true
 WEBSERVER_LOGIN={}
 WEBSERVER_LOGLEVEL=INFO
 WEBSERVER_META_MODELING=1

packages/models-library/src/models_library/api_schemas_resource_usage_tracker/licensed_items_checkouts.py

@@ -1,7 +1,7 @@
 from datetime import datetime
 from typing import NamedTuple
 
-from models_library.licensed_items import LicensedItemID
+from models_library.licenses import LicensedItemID
 from models_library.products import ProductName
 from models_library.resource_tracker_licensed_items_checkouts import (
     LicensedItemCheckoutID,

packages/models-library/src/models_library/api_schemas_resource_usage_tracker/licensed_items_purchases.py

@@ -2,7 +2,7 @@
 from decimal import Decimal
 from typing import NamedTuple
 
-from models_library.licensed_items import LicensedItemID
+from models_library.licenses import LicensedItemID
 from models_library.products import ProductName
 from models_library.resource_tracker import PricingUnitCostId
 from models_library.resource_tracker_licensed_items_purchases import (

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

@@ -1,17 +1,18 @@
 from datetime import datetime
-from typing import Any, NamedTuple, cast
+from typing import Any, NamedTuple, Self, cast
 
-from models_library.licensed_items import (
+from models_library.basic_types import IDStr
+from models_library.resource_tracker import PricingPlanId
+from pydantic import BaseModel, ConfigDict, HttpUrl, PositiveInt
+from pydantic.config import JsonDict
+
+from ..licenses import (
     VIP_DETAILS_EXAMPLE,
+    FeaturesDict,
+    LicensedItem,
     LicensedItemID,
     LicensedResourceType,
 )
-from models_library.resource_tracker import PricingPlanId
-from models_library.utils.common_validators import to_camel_recursive
-from pydantic import AfterValidator, BaseModel, ConfigDict, PositiveInt
-from pydantic.config import JsonDict
-from typing_extensions import Annotated
-
 from ._base import OutputSchema
 
 # RPC
@@ -25,6 +26,7 @@ class LicensedItemRpcGet(BaseModel):
     pricing_plan_id: PricingPlanId
     created_at: datetime
     modified_at: datetime
+
     model_config = ConfigDict(
         json_schema_extra={
             "examples": [
@@ -50,33 +52,75 @@ class LicensedItemRpcGetPage(NamedTuple):
 # Rest
 
 
+class _ItisVipRestData(OutputSchema):
+    description: str
+    thumbnail: str
+    features: FeaturesDict  # NOTE: here there is a bit of coupling with domain model
+    doi: str
+
+
+class _ItisVipResourceRestData(OutputSchema):
+    category_id: IDStr
+    category_display: str
+    source: _ItisVipRestData
+    terms_of_use_url: HttpUrl | None = None
+
+
 class LicensedItemRestGet(OutputSchema):
     licensed_item_id: LicensedItemID
     display_name: str
+    # NOTE: to put here a discriminator we have to embed it one more layer
     licensed_resource_type: LicensedResourceType
-    licensed_resource_data: Annotated[
-        dict[str, Any], AfterValidator(to_camel_recursive)
-    ]
+    licensed_resource_data: _ItisVipResourceRestData
     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",
-                    "display_name": "best-model",
-                    "licensed_resource_type": f"{LicensedResourceType.VIP_MODEL}",
-                    "licensed_resource_data": cast(JsonDict, VIP_DETAILS_EXAMPLE),
-                    "pricing_plan_id": "15",
-                    "created_at": "2024-12-12 09:59:26.422140",
-                    "modified_at": "2024-12-12 09:59:26.422140",
-                }
-            ]
-        }
-    )
+    @staticmethod
+    def _update_json_schema_extra(schema: JsonDict) -> None:
+        schema.update(
+            {
+                "examples": [
+                    {
+                        "licensedItemId": "0362b88b-91f8-4b41-867c-35544ad1f7a1",
+                        "displayName": "my best model",
+                        "licensedResourceName": "best-model",
+                        "licensedResourceType": f"{LicensedResourceType.VIP_MODEL}",
+                        "licensedResourceData": cast(
+                            JsonDict,
+                            {
+                                "categoryId": "HumanWholeBody",
+                                "categoryDisplay": "Humans",
+                                "source": VIP_DETAILS_EXAMPLE,
+                            },
+                        ),
+                        "pricingPlanId": "15",
+                        "createdAt": "2024-12-12 09:59:26.422140",
+                        "modifiedAt": "2024-12-12 09:59:26.422140",
+                    }
+                ]
+            }
+        )
+
+    model_config = ConfigDict(json_schema_extra=_update_json_schema_extra)
+
+    @classmethod
+    def from_domain_model(cls, item: LicensedItem) -> Self:
+
+        return cls.model_validate(
+            {
+                "licensed_item_id": item.licensed_item_id,
+                "display_name": item.display_name,
+                "licensed_resource_type": item.licensed_resource_type,
+                "licensed_resource_data": {
+                    **item.licensed_resource_data,
+                },
+                "pricing_plan_id": item.pricing_plan_id,
+                "created_at": item.created_at,
+                "modified_at": item.modified_at,
+            }
+        )
 
 
 class LicensedItemRestGetPage(NamedTuple):

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

@@ -4,7 +4,7 @@
 from models_library.emails import LowerCaseEmailStr
 from pydantic import BaseModel, ConfigDict, PositiveInt
 
-from ..licensed_items import LicensedItemID
+from ..licenses import LicensedItemID
 from ..products import ProductName
 from ..resource_tracker_licensed_items_checkouts import LicensedItemCheckoutID
 from ..users import UserID

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

@@ -5,7 +5,7 @@
 from models_library.emails import LowerCaseEmailStr
 from pydantic import PositiveInt
 
-from ..licensed_items import LicensedItemID
+from ..licenses import LicensedItemID
 from ..products import ProductName
 from ..resource_tracker import PricingUnitCostId
 from ..resource_tracker_licensed_items_purchases import LicensedItemPurchaseID

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

@@ -0,0 +1,127 @@
+from datetime import datetime
+from enum import auto
+from typing import Any, NamedTuple, NotRequired, TypeAlias, cast
+from uuid import UUID
+
+from models_library.resource_tracker import PricingPlanId
+from pydantic import BaseModel, ConfigDict, PositiveInt
+from pydantic.config import JsonDict
+from typing_extensions import TypedDict
+
+from .products import ProductName
+from .resource_tracker import PricingPlanId
+from .utils.enums import StrAutoEnum
+
+LicensedItemID: TypeAlias = UUID
+
+
+class LicensedResourceType(StrAutoEnum):
+    VIP_MODEL = auto()
+
+
+VIP_FEATURES_EXAMPLE = {
+    "name": "Duke",
+    "version": "V2.0",
+    "sex": "Male",
+    "age": "34 years",
+    "weight": "70.2 Kg",
+    "height": "1.77 m",
+    "date": "2015-03-01",
+    "ethnicity": "Caucasian",
+    "functionality": "Static",
+    "additional_field": "allowed",
+}
+
+
+class FeaturesDict(TypedDict):
+    name: NotRequired[str]
+    version: NotRequired[str]
+    sex: NotRequired[str]
+    age: NotRequired[str]
+    weight: NotRequired[str]
+    height: NotRequired[str]
+    date: str
+    ethnicity: NotRequired[str]
+    functionality: NotRequired[str]
+
+
+VIP_DETAILS_EXAMPLE = {
+    "id": 1,
+    "description": "A detailed description of the VIP model",
+    "thumbnail": "https://example.com/thumbnail.jpg",
+    "features": VIP_FEATURES_EXAMPLE,
+    "doi": "10.1000/xyz123",
+    "license_key": "ABC123XYZ",
+    "license_version": "1.0",
+    "protection": "Encrypted",
+    "available_from_url": "https://example.com/download",
+    "additional_field": "trimmed if rest",
+}
+
+
+#
+# DB
+#
+
+
+class LicensedItemDB(BaseModel):
+    licensed_item_id: LicensedItemID
+    display_name: str
+
+    licensed_resource_name: str
+    licensed_resource_type: LicensedResourceType
+    licensed_resource_data: dict[str, Any] | None
+
+    pricing_plan_id: PricingPlanId | None
+    product_name: ProductName | None
+
+    # states
+    created: datetime
+    modified: datetime
+    trashed: datetime | None
+
+    model_config = ConfigDict(from_attributes=True)
+
+
+class LicensedItemUpdateDB(BaseModel):
+    display_name: str | None = None
+    licensed_resource_name: str | None = None
+    pricing_plan_id: PricingPlanId | None = None
+    trash: bool | None = None
+
+
+class LicensedItem(BaseModel):
+    licensed_item_id: LicensedItemID
+    display_name: str
+    licensed_resource_name: str
+    licensed_resource_type: LicensedResourceType
+    licensed_resource_data: dict[str, Any]
+    pricing_plan_id: PricingPlanId
+    created_at: datetime
+    modified_at: datetime
+
+    @staticmethod
+    def _update_json_schema_extra(schema: JsonDict) -> None:
+        schema.update(
+            {
+                "examples": [
+                    {
+                        "licensed_item_id": "0362b88b-91f8-4b41-867c-35544ad1f7a1",
+                        "display_name": "my best model",
+                        "licensed_resource_name": "best-model",
+                        "licensed_resource_type": f"{LicensedResourceType.VIP_MODEL}",
+                        "licensed_resource_data": cast(JsonDict, VIP_DETAILS_EXAMPLE),
+                        "pricing_plan_id": "15",
+                        "created_at": "2024-12-12 09:59:26.422140",
+                        "modified_at": "2024-12-12 09:59:26.422140",
+                    }
+                ]
+            }
+        )
+
+    model_config = ConfigDict(json_schema_extra=_update_json_schema_extra)
+
+
+class LicensedItemPage(NamedTuple):
+    total: PositiveInt
+    items: list[LicensedItem]

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

@@ -5,7 +5,7 @@
 
 from pydantic import BaseModel, ConfigDict
 
-from .licensed_items import LicensedItemID
+from .licenses import LicensedItemID
 from .products import ProductName
 from .resource_tracker import PricingPlanId, PricingUnitCostId, PricingUnitId
 from .users import UserID