PR reviews

Author: matusdrobuliak66

api/specs/web-server/_catalog_licensed_items.py

@@ -0,0 +1,65 @@
+""" Helper script to generate OAS automatically
+"""
+
+# pylint: disable=redefined-outer-name
+# pylint: disable=unused-argument
+# pylint: disable=unused-variable
+# pylint: disable=too-many-arguments
+
+from typing import Annotated
+
+from _common import as_query
+from fastapi import APIRouter, Depends, status
+from models_library.api_schemas_webserver.licensed_items import LicensedItemGet
+from models_library.generics import Envelope
+from models_library.rest_error import EnvelopedError
+from simcore_service_webserver._meta import API_VTAG
+from simcore_service_webserver.catalog.licenses._exceptions_handlers import (
+    _TO_HTTP_ERROR_MAP,
+)
+from simcore_service_webserver.catalog.licenses._models import (
+    LicensedItemsBodyParams,
+    LicensedItemsListQueryParams,
+    LicensedItemsPathParams,
+)
+
+router = APIRouter(
+    prefix=f"/{API_VTAG}",
+    tags=[
+        "licenses",
+        "catalog",
+    ],
+    responses={
+        i.status_code: {"model": EnvelopedError} for i in _TO_HTTP_ERROR_MAP.values()
+    },
+)
+
+
+@router.get(
+    "/catalog/licensed-items",
+    response_model=Envelope[list[LicensedItemGet]],
+)
+async def list_licensed_items(
+    _query: Annotated[as_query(LicensedItemsListQueryParams), Depends()],
+):
+    ...
+
+
+@router.get(
+    "/catalog/licensed-items/{licensed_item_id}",
+    response_model=Envelope[LicensedItemGet],
+)
+async def get_licensed_item(
+    _path: Annotated[LicensedItemsPathParams, Depends()],
+):
+    ...
+
+
+@router.post(
+    "/catalog/licensed-items/{licensed_item_id}", status_code=status.HTTP_204_NO_CONTENT
+)
+async def purchase_licensed_item(
+    _path: Annotated[LicensedItemsPathParams, Depends()],
+    _body: LicensedItemsBodyParams,
+):
+    ...

api/specs/web-server/_license_goods.py

@@ -31,11 +31,11 @@
         "_announcements",
         "_catalog",
         "_catalog_tags",  # MUST BE after _catalog
+        "_catalog_licensed_items",
         "_computations",
         "_exporter",
         "_folders",
         "_long_running_tasks",
-        "_license_goods",
         "_metamodeling",
         "_nih_sparc",
         "_nih_sparc_redirections",

api/specs/web-server/openapi.py

@@ -307,7 +307,6 @@ redis==5.0.4
     #   -r requirements/../../../packages/service-library/requirements/_base.in
 referencing==0.29.3
     # via
-    #   -c requirements/../../../packages/service-library/requirements/./constraints.txt
     #   jsonschema
     #   jsonschema-specifications
 repro-zipfile==0.3.1
@@ -393,6 +392,7 @@ wrapt==1.16.0
     #   opentelemetry-instrumentation-redis
 yarl==1.12.1
     # via
+    #   -r requirements/../../../packages/service-library/requirements/_base.in
     #   aio-pika
     #   aiohttp
     #   aiormq

packages/aws-library/requirements/_base.txt

@@ -1,22 +1,22 @@
 from datetime import datetime
 from typing import NamedTuple
 
-from models_library.license_goods import LicenseGoodID, LicenseResourceType
+from models_library.licensed_items import LicensedItemID, LicensedResourceType
 from models_library.resource_tracker import PricingPlanId
 from pydantic import PositiveInt
 
 from ._base import OutputSchema
 
 
-class LicenseGoodGet(OutputSchema):
-    license_good_id: LicenseGoodID
+class LicensedItemGet(OutputSchema):
+    licensed_item_id: LicensedItemID
     name: str
-    license_resource_type: LicenseResourceType
+    license_resource_type: LicensedResourceType
     pricing_plan_id: PricingPlanId
     created_at: datetime
     modified_at: datetime
 
 
-class LicenseGoodGetPage(NamedTuple):
-    items: list[LicenseGoodGet]
+class LicensedItemGetPage(NamedTuple):
+    items: list[LicensedItemGet]
     total: PositiveInt

packages/models-library/src/models_library/api_schemas_webserver/license_goods.py renamed to packages/models-library/src/models_library/api_schemas_webserver/licensed_items.py

@@ -8,10 +8,10 @@
 from .resource_tracker import PricingPlanId
 from .utils.enums import StrAutoEnum
 
-LicenseGoodID: TypeAlias = str
+LicensedItemID: TypeAlias = str
 
 
-class LicenseResourceType(StrAutoEnum):
+class LicensedResourceType(StrAutoEnum):
     VIP_MODEL = auto()
 
 
@@ -20,10 +20,10 @@ class LicenseResourceType(StrAutoEnum):
 #
 
 
-class LicenseGoodDB(BaseModel):
-    license_good_id: LicenseGoodID
+class LicensedItemDB(BaseModel):
+    licensed_item_id: LicensedItemID
     name: str
-    license_resource_type: LicenseResourceType
+    license_resource_type: LicensedResourceType
     pricing_plan_id: PricingPlanId
     product_name: ProductName
     created: datetime = Field(
@@ -38,6 +38,6 @@ class LicenseGoodDB(BaseModel):
     model_config = ConfigDict(from_attributes=True)
 
 
-class LicenseGoodUpdateDB(BaseModel):
+class LicensedItemUpdateDB(BaseModel):
     name: str | None = None
     pricing_plan_id: PricingPlanId | None = None

packages/models-library/src/models_library/license_goods.py renamed to packages/models-library/src/models_library/licensed_items.py

@@ -21,7 +21,7 @@ def upgrade():
         "resource_tracker_license_purchases",
         sa.Column("license_purchase_id", sa.String(), nullable=False),
         sa.Column("product_name", sa.String(), nullable=False),
-        sa.Column("license_good_id", sa.BigInteger(), nullable=False),
+        sa.Column("licensed_item_id", sa.BigInteger(), nullable=False),
         sa.Column("wallet_id", sa.BigInteger(), nullable=False),
         sa.Column(
             "start_at",
@@ -87,8 +87,8 @@ def upgrade():
         unique=False,
     )
     op.create_table(
-        "license_goods",
-        sa.Column("license_good_id", sa.String(), nullable=False),
+        "licensed_items",
+        sa.Column("licensed_item_id", sa.String(), nullable=False),
         sa.Column("name", sa.String(), nullable=False),
         sa.Column(
             "license_resource_type",
@@ -123,14 +123,14 @@ def upgrade():
             onupdate="CASCADE",
             ondelete="CASCADE",
         ),
-        sa.PrimaryKeyConstraint("license_good_id"),
+        sa.PrimaryKeyConstraint("licensed_item_id"),
     )
     # ### end Alembic commands ###
 
 
 def downgrade():
     # ### commands auto generated by Alembic - please adjust! ###
-    op.drop_table("license_goods")
+    op.drop_table("licensed_items")
     op.drop_index(
         op.f("ix_resource_tracker_license_checkouts_wallet_id"),
         table_name="resource_tracker_license_checkouts",

packages/postgres-database/src/simcore_postgres_database/migration/versions/4901050f94f4_add_license_db_tables.py

@@ -14,15 +14,15 @@ def _custom_id_generator():
     return f"lgo_{shortuuid.uuid()}"
 
 
-class LicenseResourceType(str, enum.Enum):
+class LicensedResourceType(str, enum.Enum):
     VIP_MODEL = "VIP_MODEL"
 
 
-license_goods = sa.Table(
-    "license_goods",
+licensed_items = sa.Table(
+    "licensed_items",
     metadata,
     sa.Column(
-        "license_good_id",
+        "licensed_item_id",
         sa.String,
         nullable=False,
         primary_key=True,
@@ -34,8 +34,8 @@ class LicenseResourceType(str, enum.Enum):
         nullable=False,
     ),
     sa.Column(
-        "license_resource_type",
-        sa.Enum(LicenseResourceType),
+        "licensed_resource_type",
+        sa.Enum(LicensedResourceType),
         nullable=False,
         doc="Item type, ex. VIP_MODEL",
     ),

packages/postgres-database/src/simcore_postgres_database/models/license_goods.py renamed to packages/postgres-database/src/simcore_postgres_database/models/licensed_items.py

@@ -30,7 +30,7 @@ def _custom_id_generator():
         doc="Product name",
     ),
     sa.Column(
-        "license_good_id",
+        "licensed_item_id",
         sa.BigInteger,
         nullable=False,
     ),

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

@@ -12,7 +12,8 @@ async def pass_or_acquire_connection(
     engine: AsyncEngine, connection: AsyncConnection | None = None
 ) -> AsyncIterator[AsyncConnection]:
     """
-    When to use: For READ operations only!
+    When to use: For READ operations!
+    It ensures that a connection is available for use within the context, either by using an existing connection passed as a parameter or by acquiring a new one from the engine. The caller must manage the lifecycle of any connection explicitly passed in, but the function handles the cleanup for connections it creates itself. This function **does not open new transactions** and therefore is recommended only for read-only database operations.
     """
     # NOTE: When connection is passed, the engine is actually not needed
     # NOTE: Creator is responsible of closing connection
@@ -34,7 +35,8 @@ async def transaction_context(
     engine: AsyncEngine, connection: AsyncConnection | None = None
 ):
     """
-    When to use: For WRITE operations only!
+    When to use: For WRITE operations!
+    This function manages the database connection and ensures that a transaction context is established for write operations. It supports both outer and nested transactions, providing flexibility for scenarios where transactions may already exist in the calling context.
     """
     async with pass_or_acquire_connection(engine, connection) as conn:
         if conn.in_transaction():