states

Author: pcrespov

services/web/server/src/simcore_service_webserver/licenses/_licensed_items_service.py

@@ -2,6 +2,8 @@
 
 import logging
 from datetime import UTC, datetime, timedelta
+from enum import Enum, auto
+from pprint import pformat
 
 from aiohttp import web
 from models_library.api_schemas_webserver.licensed_items import (
@@ -37,6 +39,12 @@
 _logger = logging.getLogger(__name__)
 
 
+class RegistrationState(Enum):
+    ALREADY_REGISTERED = auto()
+    DIFFERENT_RESOURCE = auto()
+    NEWLY_REGISTERED = auto()
+
+
 def _compute_difference(old_data: dict, new_data: dict):
     differences = {
         k: {"old": old_data[k], "new": new_data[k]}
@@ -49,44 +57,45 @@ def _compute_difference(old_data: dict, new_data: dict):
     return differences
 
 
-async def register_licensed_item_from_resource(
+async def register_resource_as_licensed_item(
     app: web.Application,
     *,
     licensed_resource_name: str,
     licensed_resource_type: LicensedResourceType,
     licensed_resource_data: BaseModel,
     license_key: str | None,
-) -> LicensedItemDB:
-
+) -> tuple[LicensedItemDB, RegistrationState]:
     try:
-        license_item = await _licensed_items_repository.get_by_resource_identifier(
+        licensed_item = await _licensed_items_repository.get_by_resource_identifier(
             app,
             licensed_resource_name=licensed_resource_name,
             licensed_resource_type=licensed_resource_type,
         )
 
-        if license_item.licensed_resource_data != licensed_resource_data.model_dump(
+        if licensed_item.licensed_resource_data != licensed_resource_data.model_dump(
             mode="json", exclude_unset=True
         ):
             differences = _compute_difference(
-                license_item.licensed_resource_data or {},
+                licensed_item.licensed_resource_data or {},
                 licensed_resource_data.model_dump(mode="json", exclude_unset=True),
             )
             _logger.warning(
-                "CHANGES: NEEDED for %s, %s: Resource differs from the one registered: %s",
-                licensed_resource_name,
-                licensed_resource_type,
-                differences,
-            )
-        else:
-            _logger.info(
-                "Resource %s, %s already registered",
+                "DIFFERENT_RESOURCE: %s, %s. Difference: %s",
                 licensed_resource_name,
                 licensed_resource_type,
+                pformat(differences),
             )
+            return licensed_item, RegistrationState.DIFFERENT_RESOURCE
+
+        _logger.info(
+            "ALREADY_REGISTERED: %s, %s",
+            licensed_resource_name,
+            licensed_resource_type,
+        )
+        return licensed_item, RegistrationState.ALREADY_REGISTERED
 
     except LicensedItemNotFoundError:
-        license_item = await _licensed_items_repository.create_if_not_exists(
+        licensed_item = await _licensed_items_repository.create_if_not_exists(
             app,
             licensed_resource_name=licensed_resource_name,
             licensed_resource_type=licensed_resource_type,
@@ -99,12 +108,11 @@ async def register_licensed_item_from_resource(
         )
 
         _logger.info(
-            "NEW license with resource %s, %s already registered",
+            "NEWLY_REGISTERED: %s, %s",
             licensed_resource_name,
             licensed_resource_type,
         )
-
-    return license_item
+        return licensed_item, RegistrationState.NEWLY_REGISTERED
 
 
 async def get_licensed_item(

services/web/server/tests/unit/with_dbs/04/licenses/test_itis_vip_service.py

@@ -63,7 +63,7 @@ def mock_itis_vip_downloadables_api(
         "msg": 0,
         "availableDownloads": [
             {
-                "ID": faker.random_int(min=70, max=90),
+                "ID": i,
                 "Description": faker.sentence(),
                 "Thumbnail": faker.image_url(),
                 # NOTE: this is manually added in the server side so be more robust to errors
@@ -74,7 +74,7 @@ def mock_itis_vip_downloadables_api(
                 "Protection": faker.random_element(elements=["Code", "PayPal"]),
                 "AvailableFromURL": faker.random_element(elements=[None, faker.url()]),
             }
-            for _ in range(8)
+            for i in range(8)
         ],
     }
 
@@ -148,26 +148,60 @@ async def test_sync_itis_vip_as_licensed_items(
             assert items[0].features["functionality"] == "Posable"
 
             for vip_item in items:
-                # TODO: how to update to minimize collisions? one by one?
-
-                got1 = (
-                    await _licensed_items_service.register_licensed_item_from_resource(
-                        client.app,
-                        licensed_resource_name=f"{category}/{vip_item.id}",
-                        licensed_resource_type=LicensedResourceType.VIP_MODEL,
-                        licensed_resource_data=vip_item,
-                        license_key=vip_item.license_key,
-                    )
+                (
+                    got1,
+                    state1,
+                ) = await _licensed_items_service.register_resource_as_licensed_item(
+                    client.app,
+                    licensed_resource_name=f"{category}/{vip_item.id}",
+                    licensed_resource_type=LicensedResourceType.VIP_MODEL,
+                    licensed_resource_data=vip_item,
+                    license_key=vip_item.license_key,
+                )
+                assert (
+                    state1 == _licensed_items_service.RegistrationState.NEWLY_REGISTERED
                 )
 
-                got2 = (
-                    await _licensed_items_service.register_licensed_item_from_resource(
-                        client.app,
-                        licensed_resource_name=f"{category}/{vip_item.id}",
-                        licensed_resource_type=LicensedResourceType.VIP_MODEL,
-                        licensed_resource_data=vip_item,
-                        license_key=vip_item.license_key,
-                    )
+                (
+                    got2,
+                    state2,
+                ) = await _licensed_items_service.register_resource_as_licensed_item(
+                    client.app,
+                    licensed_resource_name=f"{category}/{vip_item.id}",
+                    licensed_resource_type=LicensedResourceType.VIP_MODEL,
+                    licensed_resource_data=vip_item,
+                    license_key=vip_item.license_key,
                 )
 
+                assert (
+                    state2
+                    == _licensed_items_service.RegistrationState.ALREADY_REGISTERED
+                )
                 assert got1 == got2
+
+                # Modify vip_item and register again
+                vip_item_modified = vip_item.model_copy(
+                    update={
+                        "features": {
+                            **vip_item.features,
+                            "functionality": "Non-Posable",
+                        }
+                    }
+                )
+                (
+                    got3,
+                    state3,
+                ) = await _licensed_items_service.register_resource_as_licensed_item(
+                    client.app,
+                    licensed_resource_name=f"{category}/{vip_item.id}",
+                    licensed_resource_type=LicensedResourceType.VIP_MODEL,
+                    licensed_resource_data=vip_item_modified,
+                    license_key=vip_item.license_key,
+                )
+
+                assert (
+                    state3
+                    == _licensed_items_service.RegistrationState.DIFFERENT_RESOURCE
+                )
+                # not stored!
+                assert got2 == got3