orchestrator-core 4.5.0a4__tar.gz → 4.5.0a6__tar.gz

{orchestrator_core-4.5.0a4 → orchestrator_core-4.5.0a6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: orchestrator-core
-Version: 4.5.0a4
+Version: 4.5.0a6
 Summary: This is the orchestrator workflow engine.
 Author-email: SURF <automation-beheer@surf.nl>
 Requires-Python: >=3.11,<3.14
@@ -79,7 +79,7 @@ Provides-Extra: llm
 [![codecov](https://codecov.io/gh/workfloworchestrator/orchestrator-core/branch/main/graph/badge.svg?token=5ANQFI2DHS)](https://codecov.io/gh/workfloworchestrator/orchestrator-core)
 [![pypi_version](https://img.shields.io/pypi/v/orchestrator-core?color=%2334D058&label=pypi%20package)](https://pypi.org/project/orchestrator-core)
 [![Supported python versions](https://img.shields.io/pypi/pyversions/orchestrator-core.svg?color=%2334D058)](https://pypi.org/project/orchestrator-core)
-![Discord](https://img.shields.io/discord/1295834294270558280?style=flat&logo=discord&label=discord&link=https%3A%2F%2Fdiscord.gg%2FKNgF6gE8)
+![Discord](https://img.shields.io/discord/1295834294270558280?style=flat&logo=discord&label=discord&link=https%3A%2F%2Fdiscord.gg%fQkQn5ajFR)
 
 <p style="text-align: center"><em>Production ready Orchestration Framework to manage product lifecycle and workflows. Easy to use, built on top of FastAPI and Pydantic</em></p>
 

{orchestrator_core-4.5.0a4 → orchestrator_core-4.5.0a6}/README.md

@@ -4,7 +4,7 @@
 [![codecov](https://codecov.io/gh/workfloworchestrator/orchestrator-core/branch/main/graph/badge.svg?token=5ANQFI2DHS)](https://codecov.io/gh/workfloworchestrator/orchestrator-core)
 [![pypi_version](https://img.shields.io/pypi/v/orchestrator-core?color=%2334D058&label=pypi%20package)](https://pypi.org/project/orchestrator-core)
 [![Supported python versions](https://img.shields.io/pypi/pyversions/orchestrator-core.svg?color=%2334D058)](https://pypi.org/project/orchestrator-core)
-![Discord](https://img.shields.io/discord/1295834294270558280?style=flat&logo=discord&label=discord&link=https%3A%2F%2Fdiscord.gg%2FKNgF6gE8)
+![Discord](https://img.shields.io/discord/1295834294270558280?style=flat&logo=discord&label=discord&link=https%3A%2F%2Fdiscord.gg%fQkQn5ajFR)
 
 <p style="text-align: center"><em>Production ready Orchestration Framework to manage product lifecycle and workflows. Easy to use, built on top of FastAPI and Pydantic</em></p>
 

{orchestrator_core-4.5.0a4 → orchestrator_core-4.5.0a6}/orchestrator/__init__.py

@@ -13,7 +13,7 @@
 
 """This is the orchestrator workflow engine."""
 
-__version__ = "4.5.0a4"
+__version__ = "4.5.0a6"
 
 
 from structlog import get_logger

{orchestrator_core-4.5.0a4 → orchestrator_core-4.5.0a6}/orchestrator/api/api_v1/endpoints/processes.py

@@ -244,6 +244,8 @@ def continue_awaiting_process_endpoint(
         continue_awaiting_process(process, token=token, input_data=json_data, broadcast_func=broadcast_func)
     except AssertionError as e:
         raise_status(HTTPStatus.NOT_FOUND, str(e))
+    except ValueError as e:
+        raise_status(HTTPStatus.BAD_REQUEST, str(e))
 
 
 @router.post(

{orchestrator_core-4.5.0a4 → orchestrator_core-4.5.0a6}/orchestrator/domain/base.py

@@ -614,9 +614,7 @@ class ProductBlockModel(DomainModel):
         product_blocks_in_model = cls._get_depends_on_product_block_types()
         product_blocks_types_in_model = get_depends_on_product_block_type_list(product_blocks_in_model)
 
-        product_blocks_in_model = set(
-            flatten(map(attrgetter("__names__"), product_blocks_types_in_model))
-        )  # type: ignore
+        product_blocks_in_model = set(flatten(map(attrgetter("__names__"), product_blocks_types_in_model)))  # type: ignore
 
         missing_product_blocks_in_db = product_blocks_in_model - product_blocks_in_db  # type: ignore
         missing_product_blocks_in_model = product_blocks_in_db - product_blocks_in_model  # type: ignore
@@ -1084,9 +1082,7 @@ class SubscriptionModel(DomainModel):
         product_blocks_in_model = cls._get_depends_on_product_block_types()
         product_blocks_types_in_model = get_depends_on_product_block_type_list(product_blocks_in_model)
 
-        product_blocks_in_model = set(
-            flatten(map(attrgetter("__names__"), product_blocks_types_in_model))
-        )  # type: ignore
+        product_blocks_in_model = set(flatten(map(attrgetter("__names__"), product_blocks_types_in_model)))  # type: ignore
 
         missing_product_blocks_in_db = product_blocks_in_model - product_blocks_in_db  # type: ignore
         missing_product_blocks_in_model = product_blocks_in_db - product_blocks_in_model  # type: ignore
@@ -1294,7 +1290,6 @@ class SubscriptionModel(DomainModel):
     # Some common functions shared by from_other_product and from_subscription
     @classmethod
     def _get_subscription(cls: type[S], subscription_id: UUID | UUIDstr) -> SubscriptionTable | None:
-
         if not isinstance(subscription_id, UUID | UUIDstr):
             raise TypeError(f"subscription_id is of type {type(subscription_id)} instead of UUID | UUIDstr")
 

{orchestrator_core-4.5.0a4 → orchestrator_core-4.5.0a6}/orchestrator/domain/lifecycle.py

@@ -16,11 +16,16 @@ from typing import TYPE_CHECKING, TypeVar
 import strawberry
 import structlog
 
+from orchestrator.settings import LifecycleValidationMode, app_settings
 from orchestrator.types import SubscriptionLifecycle
 from pydantic_forms.types import strEnum
 
 if TYPE_CHECKING:
-    from orchestrator.domain.base import DomainModel
+    from orchestrator.domain.base import DomainModel, SubscriptionModel
+else:
+    SubscriptionModel = None
+    DomainModel = None
+T = TypeVar("T", bound=SubscriptionModel)
 
 logger = structlog.get_logger(__name__)
 
@@ -71,9 +76,21 @@ def validate_lifecycle_status(
         )
 
 
-if TYPE_CHECKING:
-    from orchestrator.domain.base import DomainModel, SubscriptionModel
-else:
-    SubscriptionModel = None
-    DomainModel = None
-T = TypeVar("T", bound=SubscriptionModel)
+def validate_subscription_model_product_type(
+    subscription: SubscriptionModel,
+    validation_mode: LifecycleValidationMode = app_settings.LIFECYCLE_VALIDATION_MODE,
+) -> None:
+    """Validate that a subscription model has been instantiated with the correct product type class for its lifecycle status."""
+
+    actual_class = subscription.__class__
+    expected_class = lookup_specialized_type(actual_class, subscription.status)
+
+    if actual_class != expected_class:
+        msg = f"Subscription of type {actual_class} should use {expected_class} for lifecycle status '{subscription.status}'"
+        if validation_mode == LifecycleValidationMode.STRICT:
+            logger.error(msg)
+            raise ValueError(msg)
+        if validation_mode == LifecycleValidationMode.LOOSE:
+            logger.warning(msg)
+        elif validation_mode == LifecycleValidationMode.IGNORED:
+            pass

{orchestrator_core-4.5.0a4 → orchestrator_core-4.5.0a6}/orchestrator/migrations/helpers.py

@@ -166,12 +166,16 @@ def create_workflow(conn: sa.engine.Connection, workflow: dict) -> None:
             "is_task": False,
             "description": "workflow description",
             "product_type": "product_type",
+            "product_tag": "product_tag",
         }
         >>> create_workflow(conn, workflow)
     """
     if not workflow.get("is_task", False):
         workflow["is_task"] = False
 
+    if not workflow.get("product_tag"):
+        workflow["product_tag"] = None
+
     if has_table_column(table_name="workflows", column_name="is_task", conn=conn):
         query = """
                 WITH new_workflow AS (
@@ -186,6 +190,7 @@ def create_workflow(conn: sa.engine.Connection, workflow: dict) -> None:
                 FROM products AS p
                          CROSS JOIN new_workflow AS nw
                 WHERE p.product_type = :product_type
+                AND (:product_tag IS NULL OR p.tag = :product_tag)
                 ON CONFLICT DO NOTHING
                 """
     else:
@@ -203,6 +208,7 @@ def create_workflow(conn: sa.engine.Connection, workflow: dict) -> None:
                 FROM products AS p
                          CROSS JOIN new_workflow AS nw
                 WHERE p.product_type = :product_type
+                AND (:product_tag IS NULL OR p.tag = :product_tag)
                 ON CONFLICT DO NOTHING
                 """
 

{orchestrator_core-4.5.0a4 → orchestrator_core-4.5.0a6}/orchestrator/services/processes.py

@@ -524,6 +524,7 @@ def restart_process(
 RESUMABLE_STATUSES = (
     ProcessStatus.SUSPENDED,  # Can be resumed
     ProcessStatus.WAITING,  # Can be retried
+    ProcessStatus.AWAITING_CALLBACK,  # Can be resumed
     ProcessStatus.FAILED,  # Can be retried
     ProcessStatus.API_UNAVAILABLE,  # subtype of FAILED
     ProcessStatus.INCONSISTENT_DATA,  # subtype of FAILED

{orchestrator_core-4.5.0a4 → orchestrator_core-4.5.0a6}/orchestrator/settings.py

@@ -30,6 +30,12 @@ class ExecutorType(strEnum):
     THREADPOOL = "threadpool"
 
 
+class LifecycleValidationMode(strEnum):
+    STRICT = "strict"
+    LOOSE = "loose"
+    IGNORED = "ignored"
+
+
 class AppSettings(BaseSettings):
     TESTING: bool = True
     SESSION_SECRET: OrchSecretStr = "".join(secrets.choice(string.ascii_letters) for i in range(16))  # type: ignore
@@ -91,6 +97,7 @@ class AppSettings(BaseSettings):
     FILTER_BY_MODE: Literal["partial", "exact"] = "exact"
     EXPOSE_SETTINGS: bool = False
     EXPOSE_OAUTH_SETTINGS: bool = False
+    LIFECYCLE_VALIDATION_MODE: LifecycleValidationMode = LifecycleValidationMode.LOOSE
 
 
 app_settings = AppSettings()

{orchestrator_core-4.5.0a4 → orchestrator_core-4.5.0a6}/orchestrator/utils/state.py

@@ -19,6 +19,7 @@ from typing import Any, cast, get_args
 from uuid import UUID
 
 from orchestrator.domain.base import SubscriptionModel
+from orchestrator.domain.lifecycle import validate_subscription_model_product_type
 from orchestrator.types import StepFunc, is_list_type, is_optional_type
 from orchestrator.utils.functional import logger
 from pydantic_forms.types import (
@@ -135,7 +136,7 @@ def _save_models(state: State) -> None:
 def _build_arguments(func: StepFunc | InputStepFunc, state: State) -> list:  # noqa: C901
     """Build actual arguments based on step function signature and state.
 
-    What the step function requests in its function signature it what this function retrieves from the state or DB.
+    What the step function requests in its function signature is what this function retrieves from the state or DB.
     Domain models are retrieved from the DB (after `subscription_id` lookup in the state). Everything else is
     retrieved from the state.
 
@@ -186,6 +187,7 @@ def _build_arguments(func: StepFunc | InputStepFunc, state: State) -> list:  # n
             subscription_id = _get_sub_id(state.get(name))
             if subscription_id:
                 sub_mod = param.annotation.from_subscription(subscription_id)
+                validate_subscription_model_product_type(sub_mod)
                 arguments.append(sub_mod)
             else:
                 logger.error("Could not find key in state.", key=name, state=state)
@@ -198,12 +200,15 @@ def _build_arguments(func: StepFunc | InputStepFunc, state: State) -> list:  # n
                     f"Step function argument '{param.name}' cannot be serialized from database with type 'Any'"
                 )
             subscriptions = [actual_type.from_subscription(subscription_id) for subscription_id in subscription_ids]
+            for sub_mod in subscriptions:
+                validate_subscription_model_product_type(sub_mod)
             arguments.append(subscriptions)
         elif is_optional_type(param.annotation, SubscriptionModel):
             subscription_id = _get_sub_id(state.get(name))
             if subscription_id:
                 # Actual type is first argument from optional type
                 sub_mod = get_args(param.annotation)[0].from_subscription(subscription_id)
+                validate_subscription_model_product_type(sub_mod)
                 arguments.append(sub_mod)
             else:
                 arguments.append(None)