Merge branch 'master' into feature/standalone-projects

Author: odeimaiz

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,18 +1,27 @@
 from datetime import datetime
-from typing import NamedTuple
+from typing import Any, NamedTuple, cast
 
-from models_library.licensed_items import LicensedItemID, LicensedResourceType
+from models_library.licensed_items import (
+    VIP_DETAILS_EXAMPLE,
+    LicensedItemID,
+    LicensedResourceType,
+)
 from models_library.resource_tracker import PricingPlanId
-from pydantic import ConfigDict, PositiveInt
+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
 
-class LicensedItemGet(OutputSchema):
+
+class LicensedItemRpcGet(BaseModel):
     licensed_item_id: LicensedItemID
-    name: str
-    license_key: str | None
+    display_name: str
     licensed_resource_type: LicensedResourceType
+    licensed_resource_data: dict[str, Any]
     pricing_plan_id: PricingPlanId
     created_at: datetime
     modified_at: datetime
@@ -21,9 +30,46 @@ class LicensedItemGet(OutputSchema):
             "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}",
+                    "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",
+                }
+            ]
+        },
+    )
+
+
+class LicensedItemRpcGetPage(NamedTuple):
+    items: list[LicensedItemRpcGet]
+    total: PositiveInt
+
+
+# Rest
+
+
+class LicensedItemRestGet(OutputSchema):
+    licensed_item_id: LicensedItemID
+    display_name: str
+    licensed_resource_type: LicensedResourceType
+    licensed_resource_data: Annotated[
+        dict[str, Any], AfterValidator(to_camel_recursive)
+    ]
+    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",
@@ -33,6 +79,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

@@ -1,9 +1,9 @@
 from datetime import datetime
 from enum import auto
-from typing import TypeAlias
+from typing import Any, TypeAlias
 from uuid import UUID
 
-from pydantic import BaseModel, ConfigDict, Field
+from pydantic import BaseModel, ConfigDict
 
 from .products import ProductName
 from .resource_tracker import PricingPlanId
@@ -16,30 +16,59 @@ class LicensedResourceType(StrAutoEnum):
     VIP_MODEL = auto()
 
 
+VIP_FEAUTES_EXAMPLE = {
+    "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",
+}
+
+VIP_DETAILS_EXAMPLE = {
+    "id": 1,
+    "description": "custom description",
+    "thumbnail": "custom description",
+    "features": VIP_FEAUTES_EXAMPLE,
+    "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_name: str
     licensed_resource_type: LicensedResourceType
-    pricing_plan_id: PricingPlanId
-    product_name: ProductName
-    created: datetime = Field(
-        ...,
-        description="Timestamp on creation",
-    )
-    modified: datetime = Field(
-        ...,
-        description="Timestamp of last modification",
-    )
-    # ----
+    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):
-    name: str | None = None
+    display_name: str | None = None
+    licensed_resource_name: str | None = None
     pricing_plan_id: PricingPlanId | None = None
+    trash: bool | None = None

packages/models-library/src/models_library/utils/common_validators.py

@@ -23,6 +23,7 @@ class MyModel(BaseModel):
 from common_library.json_serialization import json_loads
 from orjson import JSONDecodeError
 from pydantic import BaseModel
+from pydantic.alias_generators import to_camel
 
 
 def empty_str_to_none_pre_validator(value: Any):
@@ -120,3 +121,18 @@ def _validator(cls: type[BaseModel], values):
         return values
 
     return _validator
+
+
+def to_camel_recursive(data: dict[str, Any]) -> dict[str, Any]:
+    """Recursively convert dictionary keys to camelCase"""
+    if not isinstance(data, dict):
+        return data  # Return as-is if it's not a dictionary
+
+    new_dict = {}
+    for key, value in data.items():
+        new_key = to_camel(key)  # Convert key to camelCase
+        if isinstance(value, dict):
+            new_dict[new_key] = to_camel_recursive(value)  # Recursive call for dicts
+        else:
+            new_dict[new_key] = value
+    return new_dict

packages/postgres-database/src/simcore_postgres_database/migration/versions/4f31760a63ba_add_data_to_licensed_items.py

@@ -0,0 +1,96 @@
+"""add data to licensed_items
+
+Revision ID: 4f31760a63ba
+Revises: 1bc517536e0a
+Create Date: 2025-01-29 16:51:16.453069+00:00
+
+"""
+import sqlalchemy as sa
+from alembic import op
+from sqlalchemy.dialects import postgresql
+
+# revision identifiers, used by Alembic.
+revision = "4f31760a63ba"
+down_revision = "1bc517536e0a"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+
+    with op.batch_alter_table("licensed_items") as batch_op:
+        batch_op.alter_column(
+            "name",
+            new_column_name="licensed_resource_name",
+            existing_type=sa.String(),
+            nullable=False,
+        )
+        batch_op.alter_column(
+            "pricing_plan_id",
+            existing_type=sa.Integer(),
+            nullable=True,
+        )
+        batch_op.alter_column(
+            "product_name",
+            existing_type=sa.String(),
+            nullable=True,
+        )
+
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column(
+        "licensed_items",
+        sa.Column(
+            "licensed_resource_data",
+            postgresql.JSONB(astext_type=sa.Text()),
+            nullable=True,
+        ),
+    )
+    op.add_column(
+        "licensed_items",
+        sa.Column(
+            "trashed",
+            sa.DateTime(timezone=True),
+            nullable=True,
+            comment="The date and time when the licensed_item was marked as trashed. Null if the licensed_item has not been trashed [default].",
+        ),
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column("licensed_items", "trashed")
+    op.drop_column("licensed_items", "licensed_resource_data")
+    # ### end Alembic commands ###
+
+    # Delete rows with null values in pricing_plan_id and product_name
+    op.execute(
+        sa.DDL(
+            """
+        DELETE FROM licensed_items
+        WHERE pricing_plan_id IS NULL OR product_name IS NULL;
+        """
+        )
+    )
+    print(
+        "Warning: Rows with null values in pricing_plan_id or product_name have been deleted."
+    )
+
+    with op.batch_alter_table("licensed_items") as batch_op:
+
+        batch_op.alter_column(
+            "product_name",
+            existing_type=sa.String(),
+            nullable=False,
+        )
+        batch_op.alter_column(
+            "pricing_plan_id",
+            existing_type=sa.Integer(),
+            nullable=False,
+        )
+        batch_op.alter_column(
+            "licensed_resource_name",
+            new_column_name="name",
+            existing_type=sa.String(),
+            nullable=False,
+        )

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

@@ -0,0 +1,34 @@
+"""modify licensed items DB
+
+Revision ID: 7d1c6425a51d
+Revises: 4f31760a63ba
+Create Date: 2025-01-30 17:32:31.969343+00:00
+
+"""
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision = "7d1c6425a51d"
+down_revision = "4f31760a63ba"
+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.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.drop_column("licensed_items", "display_name")
+    # ### end Alembic commands ###