Merge branch 'master' into fix/drop-on-folder

Author: odeimaiz

packages/models-library/src/models_library/api_schemas_directorv2/dynamic_services.py

@@ -79,3 +79,5 @@ class DynamicServiceCreate(ServiceDetails):
 
 class GetProjectInactivityResponse(BaseModel):
     is_inactive: bool
+
+    model_config = ConfigDict(json_schema_extra={"example": {"is_inactive": "false"}})

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

@@ -3,10 +3,10 @@
 
 from models_library.licensed_items import LicensedItemID
 from models_library.products import ProductName
-from models_library.resource_tracker import ServiceRunId
 from models_library.resource_tracker_licensed_items_checkouts import (
     LicensedItemCheckoutID,
 )
+from models_library.services_types import ServiceRunID
 from models_library.users import UserID
 from models_library.wallets import WalletID
 from pydantic import BaseModel, ConfigDict, PositiveInt
@@ -18,7 +18,7 @@ class LicensedItemCheckoutGet(BaseModel):
     wallet_id: WalletID
     user_id: UserID
     product_name: ProductName
-    service_run_id: ServiceRunId
+    service_run_id: ServiceRunID
     started_at: datetime
     stopped_at: datetime | None
     num_of_seats: int

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

@@ -6,14 +6,15 @@
 
 from ..projects import ProjectID
 from ..projects_nodes_io import NodeID
-from ..resource_tracker import CreditTransactionStatus, ServiceRunId, ServiceRunStatus
+from ..resource_tracker import CreditTransactionStatus, ServiceRunStatus
 from ..services import ServiceKey, ServiceVersion
+from ..services_types import ServiceRunID
 from ..users import UserID
 from ..wallets import WalletID
 
 
 class ServiceRunGet(BaseModel):
-    service_run_id: ServiceRunId
+    service_run_id: ServiceRunID
     wallet_id: WalletID | None
     wallet_name: str | None
     user_id: UserID

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

@@ -11,12 +11,12 @@
     PricingPlanId,
     PricingUnitCostUpdate,
     PricingUnitId,
-    ServiceRunId,
     ServiceRunStatus,
     SpecificInfo,
     UnitExtraInfo,
 )
 from ..services import ServiceKey, ServiceVersion
+from ..services_types import ServiceRunID
 from ..users import UserID
 from ..wallets import WalletID
 from ._base import InputSchema, OutputSchema
@@ -27,7 +27,7 @@
 class ServiceRunGet(
     BaseModel
 ):  # NOTE: this is already in use so I didnt modidy inheritance from OutputSchema
-    service_run_id: ServiceRunId
+    service_run_id: ServiceRunID
     wallet_id: WalletID | None
     wallet_name: str | None
     user_id: UserID

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

@@ -15,6 +15,7 @@
 from .projects_state import RunningState
 from .services import ServiceKey, ServiceType, ServiceVersion
 from .services_resources import ServiceResourcesDict
+from .services_types import ServiceRunID
 from .users import UserID
 from .utils.enums import StrAutoEnum
 from .wallets import WalletID
@@ -178,7 +179,7 @@ class RabbitResourceTrackingMessageType(StrAutoEnum):
 class RabbitResourceTrackingBaseMessage(RabbitMessageBase):
     channel_name: Literal["io.simcore.service.tracking"] = "io.simcore.service.tracking"
 
-    service_run_id: str = Field(
+    service_run_id: ServiceRunID = Field(
         ..., description="uniquely identitifies the service run"
     )
     created_at: datetime.datetime = Field(

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

@@ -20,7 +20,6 @@
 
 _logger = logging.getLogger(__name__)
 
-ServiceRunId: TypeAlias = str
 PricingPlanId: TypeAlias = PositiveInt
 PricingUnitId: TypeAlias = PositiveInt
 PricingUnitCostId: TypeAlias = PositiveInt

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

@@ -30,22 +30,22 @@
 class PageRefsParams(PageRefs[PageQueryParameters]):
     @classmethod
     def create(cls, total: int, limit: int, offset: int) -> "PageRefsParams":
-        last_page = ceil(total / limit) - 1
+        last_page = ceil(total / limit) - 1 if total > 0 else 0
         return cls.model_validate(
             {
                 "self": {"offset": offset, "limit": limit},
                 "first": {"offset": 0, "limit": limit},
                 "prev": (
                     {"offset": max(offset - limit, 0), "limit": limit}
-                    if offset > 0
+                    if offset > 0 and total > 0
                     else None
                 ),
                 "next": (
                     {
                         "offset": min(offset + limit, last_page * limit),
                         "limit": limit,
                     }
-                    if offset < (last_page * limit)
+                    if offset < (last_page * limit) and total > 0
                     else None
                 ),
                 "last": {"offset": last_page * limit, "limit": limit},

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

@@ -7,9 +7,9 @@
 from .services_metadata_published import ServiceInputsDict, ServiceMetaDataPublished
 from .services_types import (
     DynamicServiceKey,
-    RunID,
     ServiceKey,
     ServicePortKey,
+    ServiceRunID,
     ServiceVersion,
 )
 
@@ -21,14 +21,14 @@
     "BootOptions",
     "DynamicServiceKey",
     "LATEST_INTEGRATION_VERSION",
-    "RunID",
     "ServiceInput",
     "ServiceInputsDict",
     "ServiceKey",
     "ServiceKeyVersion",
     "ServiceMetaDataPublished",
     "ServiceOutput",
     "ServicePortKey",
+    "ServiceRunID",
     "ServiceType",
     "ServiceVersion",
 )

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

@@ -1,18 +1,28 @@
-from typing import Annotated, Any, TypeAlias
+from typing import TYPE_CHECKING, Annotated, Any, Self, TypeAlias
 from uuid import uuid4
 
 import arrow
-from pydantic import GetCoreSchemaHandler, StringConstraints, ValidationInfo
+from pydantic import (
+    GetCoreSchemaHandler,
+    PositiveInt,
+    StringConstraints,
+    ValidationInfo,
+)
 from pydantic_core import CoreSchema, core_schema
 
 from .basic_regex import PROPERTY_KEY_RE, SIMPLE_VERSION_RE
+from .projects_nodes_io import NodeID
 from .services_regex import (
     COMPUTATIONAL_SERVICE_KEY_RE,
     DYNAMIC_SERVICE_KEY_RE,
     FILENAME_RE,
     SERVICE_ENCODED_KEY_RE,
     SERVICE_KEY_RE,
 )
+from .users import UserID
+
+if TYPE_CHECKING:
+    from .projects import ProjectID
 
 ServicePortKey: TypeAlias = Annotated[str, StringConstraints(pattern=PROPERTY_KEY_RE)]
 
@@ -35,7 +45,7 @@
 ServiceVersion: TypeAlias = Annotated[str, StringConstraints(pattern=SIMPLE_VERSION_RE)]
 
 
-class RunID(str):
+class ServiceRunID(str):
     """
     Used to assign a unique identifier to the run of a service.
 
@@ -44,12 +54,15 @@ class RunID(str):
     and old volumes for different runs.
     Avoids overwriting data that left dropped on the node (due to an error)
     and gives the osparc-agent an opportunity to back it up.
+    The resource-usage-tracker tracker uses these RunIDs to keep track of
+    resource usage from computational and dynamic services.
     """
 
     __slots__ = ()
 
     @classmethod
-    def create(cls) -> "RunID":
+    def get_resource_tracking_run_id_for_dynamic(cls) -> Self:
+        """used for dynamic services"""
         # NOTE: there was a legacy version of this RunID
         # legacy version:
         #   '0ac3ed64-665b-42d2-95f7-e59e0db34242'
@@ -59,6 +72,17 @@ def create(cls) -> "RunID":
         run_id_format = f"{utc_int_timestamp}_{uuid4()}"
         return cls(run_id_format)
 
+    @classmethod
+    def get_resource_tracking_run_id_for_computational(
+        cls,
+        user_id: UserID,
+        project_id: "ProjectID",
+        node_id: NodeID,
+        iteration: PositiveInt,
+    ) -> Self:
+        """used by computational services"""
+        return cls(f"comp_{user_id}_{project_id}_{node_id}_{iteration}")
+
     @classmethod
     def __get_pydantic_core_schema__(
         cls,
@@ -68,7 +92,7 @@ def __get_pydantic_core_schema__(
         return core_schema.no_info_after_validator_function(cls, handler(str))
 
     @classmethod
-    def validate(cls, v: "RunID | str", _: ValidationInfo) -> "RunID":
+    def validate(cls, v: "ServiceRunID | str", _: ValidationInfo) -> "ServiceRunID":
         if isinstance(v, cls):
             return v
         if isinstance(v, str):

packages/models-library/tests/test_rest_pagination.py

@@ -2,7 +2,7 @@
 
 import pytest
 from models_library.rest_pagination import Page, PageMetaInfoLimitOffset
-from pydantic.main import BaseModel
+from pydantic import BaseModel, ValidationError
 from pytest_simcore.examples.models_library import PAGE_EXAMPLES
 
 
@@ -26,7 +26,7 @@ def test_page_response_limit_offset_models(cls_model: BaseModel, examples: list[
 
 
 def test_invalid_offset():
-    with pytest.raises(ValueError):
+    with pytest.raises(ValidationError):
         PageMetaInfoLimitOffset(limit=6, total=5, offset=5, count=2)
 
 
@@ -39,14 +39,14 @@ def test_invalid_offset():
     ],
 )
 def test_invalid_count(count: int, offset: int):
-    with pytest.raises(ValueError):
+    with pytest.raises(ValidationError):
         PageMetaInfoLimitOffset(limit=6, total=5, offset=offset, count=count)
 
 
 def test_data_size_does_not_fit_count():
     example = deepcopy(PAGE_EXAMPLES[0])
     example["_meta"]["count"] = len(example["data"]) - 1
-    with pytest.raises(ValueError):
+    with pytest.raises(ValidationError):
         Page[str](**example)