Merge branch 'master' into is1905/add-new-fuctions-rest-api-endpoints

Author: giancarloromeo

.github/workflows/ci-arm-build.yml

@@ -38,7 +38,7 @@ jobs:
       - name: show system environs
         run: ./ci/helpers/show_system_versions.bash
       - name: login to Dockerhub
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKER_PASSWORD }}

.github/workflows/ci-multi-architecture-fusing.yml

@@ -39,7 +39,7 @@ jobs:
       - name: show system environs
         run: ./ci/helpers/show_system_versions.bash
       - name: login to Dockerhub
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKER_PASSWORD }}

api/specs/web-server/_users.py

@@ -10,8 +10,6 @@
 from models_library.api_schemas_webserver.users import (
     MyFunctionPermissionsGet,
     MyPermissionGet,
-    MyPhoneConfirm,
-    MyPhoneRegister,
     MyProfileRestGet,
     MyProfileRestPatch,
     MyTokenCreate,
@@ -32,6 +30,10 @@
     UserNotificationCreate,
     UserNotificationPatch,
 )
+from simcore_service_webserver.users._controller.rest._rest_schemas import (
+    MyPhoneConfirm,
+    MyPhoneRegister,
+)
 
 router = APIRouter(prefix=f"/{API_VTAG}", tags=["users"])
 

api/specs/web-server/_users_admin.py

@@ -19,7 +19,7 @@
 from models_library.generics import Envelope
 from models_library.rest_pagination import Page
 from simcore_service_webserver._meta import API_VTAG
-from simcore_service_webserver.users.schemas import PreRegisteredUserGet
+from simcore_service_webserver.users.schemas import UserAccountRestPreRegister
 
 router = APIRouter(prefix=f"/{API_VTAG}", tags=["users"])
 
@@ -69,4 +69,4 @@ async def search_user_accounts(
     response_model=Envelope[UserAccountGet],
     tags=_extra_tags,
 )
-async def pre_register_user_account(_body: PreRegisteredUserGet): ...
+async def pre_register_user_account(_body: UserAccountRestPreRegister): ...

packages/models-library/src/models_library/api_schemas_long_running_tasks/tasks.py

@@ -2,7 +2,8 @@
 from datetime import datetime
 from typing import Any
 
-from pydantic import BaseModel, field_validator
+from common_library.exclude import Unset
+from pydantic import BaseModel, ConfigDict, model_validator
 
 from .base import TaskId, TaskProgress
 
@@ -20,15 +21,30 @@ class TaskResult(BaseModel):
 
 class TaskBase(BaseModel):
     task_id: TaskId
-    task_name: str
+    task_name: str | Unset = Unset.VALUE
+
+    @model_validator(mode="after")
+    def try_populate_task_name_from_task_id(self) -> "TaskBase":
+        # NOTE: currently this model is used to validate tasks coming from
+        # the celery backend and form long_running_tasks
+        # 1. if a task comes from Celery, it will keep it's given name
+        # 2. if a task comes from long_running_tasks, it will extract it form
+        #   the task_id, which looks like "{PREFIX}.{TASK_NAME}.UNIQUE|{UUID}"
+
+        if self.task_id and self.task_name == Unset.VALUE:
+            parts = self.task_id.split(".")
+            if len(parts) > 1:
+                self.task_name = urllib.parse.unquote(parts[1])
+
+        if self.task_name == Unset.VALUE:
+            self.task_name = self.task_id
+
+        return self
+
+    model_config = ConfigDict(arbitrary_types_allowed=True)
 
 
 class TaskGet(TaskBase):
     status_href: str
     result_href: str
     abort_href: str
-
-    @field_validator("task_name")
-    @classmethod
-    def unquote_str(cls, v) -> str:
-        return urllib.parse.unquote(v)

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

@@ -5,6 +5,7 @@
 from models_library.rest_base import RequestParameters
 from pydantic import AliasGenerator, ConfigDict, Field, HttpUrl, SecretStr
 from pydantic.alias_generators import to_camel
+from pydantic.config import JsonDict
 
 from ..emails import LowerCaseEmailStr
 from ._base import InputSchema, OutputSchema
@@ -14,33 +15,39 @@ class AccountRequestInfo(InputSchema):
     form: dict[str, Any]
     captcha: str
 
+    @staticmethod
+    def _update_json_schema_extra(schema: JsonDict) -> None:
+        schema.update(
+            {
+                "example": {
+                    "form": {
+                        "firstName": "James",
+                        "lastName": "Maxwel",
+                        "email": "[email protected]",
+                        "phone": "+41 44 245 96 96",
+                        "company": "EM Com",
+                        "address": "Infinite Loop",
+                        "city": "Washington",
+                        "postalCode": "98001",
+                        "country": "Switzerland",
+                        "application": "Antenna_Design",
+                        "description": "Description of something",
+                        "hear": "Search_Engine",
+                        "privacyPolicy": True,
+                        "eula": True,
+                    },
+                    "captcha": "A12B34",
+                }
+            }
+        )
+
     model_config = ConfigDict(
         str_strip_whitespace=True,
         str_max_length=200,
         # NOTE: this is just informative. The format of the form is defined
         # currently in the front-end and it might change
         # SEE image in  https://github.com/ITISFoundation/osparc-simcore/pull/5378
-        json_schema_extra={
-            "example": {
-                "form": {
-                    "firstName": "James",
-                    "lastName": "Maxwel",
-                    "email": "[email protected]",
-                    "phone": "+1 123456789",
-                    "company": "EM Com",
-                    "address": "Infinite Loop",
-                    "city": "Washington",
-                    "postalCode": "98001",
-                    "country": "USA",
-                    "application": "Antenna_Design",
-                    "description": "Description of something",
-                    "hear": "Search_Engine",
-                    "privacyPolicy": True,
-                    "eula": True,
-                },
-                "captcha": "A12B34",
-            }
-        },
+        json_schema_extra=_update_json_schema_extra,
     )
 
 

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

@@ -207,27 +207,6 @@ def _validate_user_name(cls, value: str):
         return value
 
 
-#
-# PHONE REGISTRATION
-#
-
-
-class MyPhoneRegister(InputSchema):
-    phone: Annotated[
-        str,
-        StringConstraints(strip_whitespace=True, min_length=1),
-        Field(description="Phone number to register"),
-    ]
-
-
-class MyPhoneConfirm(InputSchema):
-    code: Annotated[
-        str,
-        StringConstraints(strip_whitespace=True, pattern=r"^[A-Za-z0-9]+$"),
-        Field(description="Alphanumeric confirmation code"),
-    ]
-
-
 #
 # USER
 #

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

@@ -1,24 +1,21 @@
+import os
 from copy import deepcopy
-from typing import Any, TypeVar
+from typing import Annotated, Any, Final, TypeVar
 
 from common_library.errors_classes import OsparcErrorMixin
 from models_library.basic_types import ConstrainedStr
-
-from pydantic import BaseModel
+from pydantic import BaseModel, Discriminator, PositiveInt, Tag
 
 from .utils.string_substitution import OSPARC_IDENTIFIER_PREFIX
+from .utils.types import get_types_from_annotated_union
 
 T = TypeVar("T")
 
 
-class OsparcVariableIdentifier(ConstrainedStr):
+class _BaseOsparcVariableIdentifier(ConstrainedStr):
     # NOTE: To allow parametrized value, set the type to Union[OsparcVariableIdentifier, ...]
     # NOTE: When dealing with str types, to avoid unexpected behavior, the following
     # order is suggested `OsparcVariableIdentifier | str`
-    # NOTE: in below regex `{`` and `}` are respectively escaped with `{{` and `}}`
-    pattern = (
-        rf"^\${{1,2}}(?:\{{)?{OSPARC_IDENTIFIER_PREFIX}[A-Za-z0-9_]+(?:\}})?(:-.+)?$"
-    )
 
     def _get_without_template_markers(self) -> str:
         # $VAR
@@ -42,6 +39,40 @@ def default_value(self) -> str | None:
         parts = self._get_without_template_markers().split(":-")
         return parts[1] if len(parts) > 1 else None
 
+    @staticmethod
+    def get_pattern(max_dollars: PositiveInt) -> str:
+        # NOTE: in below regex `{`` and `}` are respectively escaped with `{{` and `}}`
+        return rf"^\${{1,{max_dollars}}}(?:\{{)?{OSPARC_IDENTIFIER_PREFIX}[A-Za-z0-9_]+(?:\}})?(:-.+)?$"
+
+
+class PlatformOsparcVariableIdentifier(_BaseOsparcVariableIdentifier):
+    pattern = _BaseOsparcVariableIdentifier.get_pattern(max_dollars=2)
+
+
+class OoilOsparcVariableIdentifier(_BaseOsparcVariableIdentifier):
+    pattern = _BaseOsparcVariableIdentifier.get_pattern(max_dollars=4)
+
+
+_PLATFORM: Final[str] = "platform"
+_OOIL_VERSION: Final[str] = "ooil-version"
+
+
+def _get_discriminator_value(v: Any) -> str:
+    _ = v
+    if os.environ.get("ENABLE_OOIL_OSPARC_VARIABLE_IDENTIFIER", None):
+        return _OOIL_VERSION
+
+    return _PLATFORM
+
+
+OsparcVariableIdentifier = Annotated[
+    (
+        Annotated[PlatformOsparcVariableIdentifier, Tag(_PLATFORM)]
+        | Annotated[OoilOsparcVariableIdentifier, Tag(_OOIL_VERSION)]
+    ),
+    Discriminator(_get_discriminator_value),
+]
+
 
 class UnresolvedOsparcVariableIdentifierError(OsparcErrorMixin, TypeError):
     msg_template = "Provided argument is unresolved: value={value}"
@@ -59,9 +90,9 @@ def example_func(par: OsparcVariableIdentifier | int) -> None:
     Raises:
         TypeError: if the the OsparcVariableIdentifier was unresolved
     """
-    if isinstance(var, OsparcVariableIdentifier):
+    if isinstance(var, get_types_from_annotated_union(OsparcVariableIdentifier)):
         raise UnresolvedOsparcVariableIdentifierError(value=var)
-    return var
+    return var  # type: ignore[return-value]
 
 
 def replace_osparc_variable_identifier(  # noqa: C901
@@ -86,11 +117,11 @@ def replace_osparc_variable_identifier(  # noqa: C901
     ```
     """
 
-    if isinstance(obj, OsparcVariableIdentifier):
-        if obj.name in osparc_variables:
-            return deepcopy(osparc_variables[obj.name])  # type: ignore
-        if obj.default_value is not None:
-            return deepcopy(obj.default_value)  # type: ignore
+    if isinstance(obj, get_types_from_annotated_union(OsparcVariableIdentifier)):
+        if obj.name in osparc_variables:  # type: ignore[attr-defined]
+            return deepcopy(osparc_variables[obj.name])  # type: ignore[no-any-return,attr-defined]
+        if obj.default_value is not None:  # type: ignore[attr-defined]
+            return deepcopy(obj.default_value)  # type: ignore[no-any-return,attr-defined]
     elif isinstance(obj, dict):
         for key, value in obj.items():
             obj[key] = replace_osparc_variable_identifier(value, osparc_variables)
@@ -124,7 +155,7 @@ def raise_if_unresolved_osparc_variable_identifier_found(obj: Any) -> None:
         UnresolvedOsparcVariableIdentifierError: if not all instances of
         `OsparcVariableIdentifier` were replaced
     """
-    if isinstance(obj, OsparcVariableIdentifier):
+    if isinstance(obj, get_types_from_annotated_union(OsparcVariableIdentifier)):
         raise_if_unresolved(obj)
     elif isinstance(obj, dict):
         for key, value in obj.items():

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

@@ -126,6 +126,7 @@ def _update_json_schema_extra(schema: JsonDict) -> None:
 
 
 class EnvelopedError(Envelope[None]):
+    # SEE https://github.com/ITISFoundation/osparc-simcore/issues/443
     error: ErrorGet
 
     model_config = ConfigDict(

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

@@ -1,10 +1,21 @@
 from collections.abc import Generator
 from typing import Final
 
-from pydantic import BaseModel, ConfigDict, Field, TypeAdapter, ValidationInfo, field_validator
+from pydantic import (
+    BaseModel,
+    ConfigDict,
+    Field,
+    TypeAdapter,
+    ValidationInfo,
+    field_validator,
+)
 
 from .basic_types import PortInt
-from .osparc_variable_identifier import OsparcVariableIdentifier, raise_if_unresolved
+from .osparc_variable_identifier import (
+    OsparcVariableIdentifier,
+    raise_if_unresolved,
+)
+from .utils.types import get_types_from_annotated_union
 
 # Cloudflare DNS server address
 DEFAULT_DNS_SERVER_ADDRESS: Final[str] = "1.1.1.1"  # NOSONAR
@@ -20,13 +31,15 @@ class _PortRange(BaseModel):
     @field_validator("upper")
     @classmethod
     def lower_less_than_upper(cls, v, info: ValidationInfo) -> PortInt:
-        if isinstance(v, OsparcVariableIdentifier):
+        if isinstance(v, get_types_from_annotated_union(OsparcVariableIdentifier)):
             return v  # type: ignore # bypass validation if unresolved
 
         upper = v
         lower: PortInt | OsparcVariableIdentifier | None = info.data.get("lower")
 
-        if lower and isinstance(lower, OsparcVariableIdentifier):
+        if lower and isinstance(
+            lower, get_types_from_annotated_union(OsparcVariableIdentifier)
+        ):
             return v  # type: ignore # bypass validation if unresolved
 
         if lower is None or lower >= upper: