hatchet-sdk 1.8.1__tar.gz → 1.9.0__tar.gz

{hatchet_sdk-1.8.1 → hatchet_sdk-1.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hatchet-sdk
-Version: 1.8.1
+Version: 1.9.0
 Summary: 
 License: MIT
 Author: Alexander Belanger

{hatchet_sdk-1.8.1 → hatchet_sdk-1.9.0}/hatchet_sdk/config.py

@@ -64,13 +64,20 @@ class ClientConfig(BaseSettings):
     )
 
     worker_preset_labels: dict[str, str] = Field(default_factory=dict)
+
     enable_force_kill_sync_threads: bool = False
+    enable_thread_pool_monitoring: bool = False
 
     @model_validator(mode="after")
     def validate_token_and_tenant(self) -> "ClientConfig":
         if not self.token:
             raise ValueError("Token must be set")
 
+        if not self.token.startswith("ey"):
+            raise ValueError(
+                f"Token must be a valid JWT. Hint: These are the first few characters of the token provided: {self.token[:5]}"
+            )
+
         if not self.tenant_id:
             self.tenant_id = get_tenant_id_from_jwt(self.token)
 

{hatchet_sdk-1.8.1 → hatchet_sdk-1.9.0}/hatchet_sdk/context/context.py

@@ -69,7 +69,7 @@ class Context:
     def trigger_data(self) -> JSONSerializableMapping:
         return self.data.triggers
 
-    def _task_output(self, task: "Task[TWorkflowInput, R]") -> "R":
+    def task_output(self, task: "Task[TWorkflowInput, R]") -> "R":
         from hatchet_sdk.runnables.types import R
 
         if self.was_skipped(task):
@@ -85,19 +85,6 @@ class Context:
 
         return parent_step_data
 
-    def task_output(self, task: "Task[TWorkflowInput, R]") -> "R":
-        from hatchet_sdk.runnables.types import R
-
-        ## If the task is async, we need to wrap its output in a coroutine
-        ## so that the type checker behaves right
-        async def _aio_output() -> "R":
-            return self._task_output(task)
-
-        if task.is_async_function:
-            return cast(R, _aio_output())
-
-        return self._task_output(task)
-
     def aio_task_output(self, task: "Task[TWorkflowInput, R]") -> "R":
         warn(
             "`aio_task_output` is deprecated. Use `task_output` instead.",

{hatchet_sdk-1.8.1 → hatchet_sdk-1.9.0}/hatchet_sdk/hatchet.py

@@ -32,6 +32,7 @@ from hatchet_sdk.runnables.types import (
 )
 from hatchet_sdk.runnables.workflow import BaseWorkflow, Workflow
 from hatchet_sdk.utils.timedelta_to_expression import Duration
+from hatchet_sdk.utils.typing import CoroutineLike
 from hatchet_sdk.worker.worker import LifespanFn, Worker
 
 
@@ -300,7 +301,10 @@ class Hatchet:
         desired_worker_labels: dict[str, DesiredWorkerLabel] = {},
         backoff_factor: float | None = None,
         backoff_max_seconds: int | None = None,
-    ) -> Callable[[Callable[[EmptyModel, Context], R]], Standalone[EmptyModel, R]]: ...
+    ) -> Callable[
+        [Callable[[EmptyModel, Context], R | CoroutineLike[R]]],
+        Standalone[EmptyModel, R],
+    ]: ...
 
     @overload
     def task(
@@ -323,7 +327,8 @@ class Hatchet:
         backoff_factor: float | None = None,
         backoff_max_seconds: int | None = None,
     ) -> Callable[
-        [Callable[[TWorkflowInput, Context], R]], Standalone[TWorkflowInput, R]
+        [Callable[[TWorkflowInput, Context], R | CoroutineLike[R]]],
+        Standalone[TWorkflowInput, R],
     ]: ...
 
     def task(
@@ -346,9 +351,13 @@ class Hatchet:
         backoff_factor: float | None = None,
         backoff_max_seconds: int | None = None,
     ) -> (
-        Callable[[Callable[[EmptyModel, Context], R]], Standalone[EmptyModel, R]]
+        Callable[
+            [Callable[[EmptyModel, Context], R | CoroutineLike[R]]],
+            Standalone[EmptyModel, R],
+        ]
         | Callable[
-            [Callable[[TWorkflowInput, Context], R]], Standalone[TWorkflowInput, R]
+            [Callable[[TWorkflowInput, Context], R | CoroutineLike[R]]],
+            Standalone[TWorkflowInput, R],
         ]
     ):
         """
@@ -426,7 +435,7 @@ class Hatchet:
         )
 
         def inner(
-            func: Callable[[TWorkflowInput, Context], R]
+            func: Callable[[TWorkflowInput, Context], R | CoroutineLike[R]],
         ) -> Standalone[TWorkflowInput, R]:
             created_task = task_wrapper(func)
 
@@ -458,7 +467,8 @@ class Hatchet:
         backoff_factor: float | None = None,
         backoff_max_seconds: int | None = None,
     ) -> Callable[
-        [Callable[[EmptyModel, DurableContext], R]], Standalone[EmptyModel, R]
+        [Callable[[EmptyModel, DurableContext], R | CoroutineLike[R]]],
+        Standalone[EmptyModel, R],
     ]: ...
 
     @overload
@@ -482,7 +492,8 @@ class Hatchet:
         backoff_factor: float | None = None,
         backoff_max_seconds: int | None = None,
     ) -> Callable[
-        [Callable[[TWorkflowInput, DurableContext], R]], Standalone[TWorkflowInput, R]
+        [Callable[[TWorkflowInput, DurableContext], R | CoroutineLike[R]]],
+        Standalone[TWorkflowInput, R],
     ]: ...
 
     def durable_task(
@@ -505,9 +516,12 @@ class Hatchet:
         backoff_factor: float | None = None,
         backoff_max_seconds: int | None = None,
     ) -> (
-        Callable[[Callable[[EmptyModel, DurableContext], R]], Standalone[EmptyModel, R]]
+        Callable[
+            [Callable[[EmptyModel, DurableContext], R | CoroutineLike[R]]],
+            Standalone[EmptyModel, R],
+        ]
         | Callable[
-            [Callable[[TWorkflowInput, DurableContext], R]],
+            [Callable[[TWorkflowInput, DurableContext], R | CoroutineLike[R]]],
             Standalone[TWorkflowInput, R],
         ]
     ):
@@ -579,7 +593,7 @@ class Hatchet:
         )
 
         def inner(
-            func: Callable[[TWorkflowInput, DurableContext], R]
+            func: Callable[[TWorkflowInput, DurableContext], R | CoroutineLike[R]],
         ) -> Standalone[TWorkflowInput, R]:
             created_task = task_wrapper(func)
 

{hatchet_sdk-1.8.1 → hatchet_sdk-1.9.0}/hatchet_sdk/runnables/task.py

@@ -1,14 +1,5 @@
 from datetime import timedelta
-from typing import (
-    TYPE_CHECKING,
-    Any,
-    Awaitable,
-    Callable,
-    Generic,
-    Union,
-    cast,
-    get_type_hints,
-)
+from typing import TYPE_CHECKING, Any, Callable, Generic, Union, cast, get_type_hints
 
 from hatchet_sdk.context.context import Context, DurableContext
 from hatchet_sdk.contracts.v1.shared.condition_pb2 import TaskConditions
@@ -27,7 +18,12 @@ from hatchet_sdk.runnables.types import (
     is_sync_fn,
 )
 from hatchet_sdk.utils.timedelta_to_expression import Duration, timedelta_to_expr
-from hatchet_sdk.utils.typing import TaskIOValidator, is_basemodel_subclass
+from hatchet_sdk.utils.typing import (
+    AwaitableLike,
+    CoroutineLike,
+    TaskIOValidator,
+    is_basemodel_subclass,
+)
 from hatchet_sdk.waits import (
     Action,
     Condition,
@@ -45,10 +41,10 @@ class Task(Generic[TWorkflowInput, R]):
     def __init__(
         self,
         _fn: Union[
-            Callable[[TWorkflowInput, Context], R]
-            | Callable[[TWorkflowInput, Context], Awaitable[R]],
-            Callable[[TWorkflowInput, DurableContext], R]
-            | Callable[[TWorkflowInput, DurableContext], Awaitable[R]],
+            Callable[[TWorkflowInput, Context], R | CoroutineLike[R]]
+            | Callable[[TWorkflowInput, Context], AwaitableLike[R]],
+            Callable[[TWorkflowInput, DurableContext], R | CoroutineLike[R]]
+            | Callable[[TWorkflowInput, DurableContext], AwaitableLike[R]],
         ],
         is_durable: bool,
         type: StepType,

{hatchet_sdk-1.8.1 → hatchet_sdk-1.9.0}/hatchet_sdk/runnables/types.py

@@ -1,17 +1,17 @@
 import asyncio
 from enum import Enum
-from typing import Any, Awaitable, Callable, ParamSpec, Type, TypeGuard, TypeVar, Union
+from typing import Any, Callable, ParamSpec, Type, TypeGuard, TypeVar, Union
 
-from pydantic import BaseModel, ConfigDict, Field, model_validator
+from pydantic import BaseModel, ConfigDict, Field
 
 from hatchet_sdk.context.context import Context, DurableContext
 from hatchet_sdk.contracts.v1.workflows_pb2 import Concurrency
 from hatchet_sdk.utils.timedelta_to_expression import Duration
-from hatchet_sdk.utils.typing import JSONSerializableMapping
+from hatchet_sdk.utils.typing import AwaitableLike, JSONSerializableMapping
 
 ValidTaskReturnType = Union[BaseModel, JSONSerializableMapping, None]
 
-R = TypeVar("R", bound=Union[ValidTaskReturnType, Awaitable[ValidTaskReturnType]])
+R = TypeVar("R", bound=ValidTaskReturnType)
 P = ParamSpec("P")
 
 
@@ -26,8 +26,6 @@ class StickyStrategy(str, Enum):
 
 class ConcurrencyLimitStrategy(str, Enum):
     CANCEL_IN_PROGRESS = "CANCEL_IN_PROGRESS"
-    DROP_NEWEST = "DROP_NEWEST"
-    QUEUE_NEWEST = "QUEUE_NEWEST"
     GROUP_ROUND_ROBIN = "GROUP_ROUND_ROBIN"
     CANCEL_NEWEST = "CANCEL_NEWEST"
 
@@ -82,31 +80,6 @@ class WorkflowConfig(BaseModel):
 
     task_defaults: TaskDefaults = TaskDefaults()
 
-    def _raise_for_invalid_expression(self, expr: str) -> None:
-        if not expr.startswith("input."):
-            return None
-
-        _, field = expr.split(".", maxsplit=2)
-
-        if field not in self.input_validator.model_fields.keys():
-            raise ValueError(
-                f"The concurrency expression provided relies on the `{field}` field, which was not present in `{self.input_validator.__name__}`."
-            )
-
-    @model_validator(mode="after")
-    def validate_concurrency_expression(self) -> "WorkflowConfig":
-        if not self.concurrency:
-            return self
-
-        if isinstance(self.concurrency, list):
-            for item in self.concurrency:
-                self._raise_for_invalid_expression(item.expression)
-
-        if isinstance(self.concurrency, ConcurrencyExpression):
-            self._raise_for_invalid_expression(self.concurrency.expression)
-
-        return self
-
 
 class StepType(str, Enum):
     DEFAULT = "default"
@@ -114,7 +87,7 @@ class StepType(str, Enum):
     ON_SUCCESS = "on_success"
 
 
-AsyncFunc = Callable[[TWorkflowInput, Context], Awaitable[R]]
+AsyncFunc = Callable[[TWorkflowInput, Context], AwaitableLike[R]]
 SyncFunc = Callable[[TWorkflowInput, Context], R]
 TaskFunc = Union[AsyncFunc[TWorkflowInput, R], SyncFunc[TWorkflowInput, R]]
 
@@ -131,7 +104,7 @@ def is_sync_fn(
     return not asyncio.iscoroutinefunction(fn)
 
 
-DurableAsyncFunc = Callable[[TWorkflowInput, DurableContext], Awaitable[R]]
+DurableAsyncFunc = Callable[[TWorkflowInput, DurableContext], AwaitableLike[R]]
 DurableSyncFunc = Callable[[TWorkflowInput, DurableContext], R]
 DurableTaskFunc = Union[
     DurableAsyncFunc[TWorkflowInput, R], DurableSyncFunc[TWorkflowInput, R]

{hatchet_sdk-1.8.1 → hatchet_sdk-1.9.0}/hatchet_sdk/runnables/workflow.py

@@ -35,7 +35,7 @@ from hatchet_sdk.runnables.types import (
 )
 from hatchet_sdk.utils.proto_enums import convert_python_enum_to_proto
 from hatchet_sdk.utils.timedelta_to_expression import Duration
-from hatchet_sdk.utils.typing import JSONSerializableMapping
+from hatchet_sdk.utils.typing import CoroutineLike, JSONSerializableMapping
 from hatchet_sdk.waits import Condition, OrGroup
 from hatchet_sdk.workflow_run import WorkflowRunRef
 
@@ -132,34 +132,6 @@ class BaseWorkflow(Generic[TWorkflowInput]):
     def _create_action_name(self, step: Task[TWorkflowInput, Any]) -> str:
         return self.service_name + ":" + step.name
 
-    def _raise_for_invalid_concurrency(
-        self, concurrency: ConcurrencyExpression
-    ) -> bool:
-        expr = concurrency.expression
-
-        if not expr.startswith("input."):
-            return True
-
-        _, field = expr.split(".", maxsplit=2)
-
-        if field not in self.config.input_validator.model_fields.keys():
-            raise ValueError(
-                f"The concurrency expression provided relies on the `{field}` field, which was not present in `{self.config.input_validator.__name__}`."
-            )
-
-        return True
-
-    def _validate_priority(self, default_priority: int | None) -> int | None:
-        validated_priority = (
-            max(1, min(3, default_priority)) if default_priority else None
-        )
-        if validated_priority != default_priority:
-            logger.warning(
-                "Warning: Default Priority Must be between 1 and 3 -- inclusively. Adjusted to be within the range."
-            )
-
-        return validated_priority
-
     def _is_leaf_task(self, task: Task[TWorkflowInput, Any]) -> bool:
         return not any(task in t.parents for t in self.tasks if task != t)
 
@@ -573,10 +545,7 @@ class Workflow(BaseWorkflow[TWorkflowInput]):
     def _parse_task_name(
         self,
         name: str | None,
-        func: (
-            Callable[[TWorkflowInput, Context], R]
-            | Callable[[TWorkflowInput, DurableContext], R]
-        ),
+        func: Callable[..., Any],
     ) -> str:
         non_null_name = name or func.__name__
 
@@ -597,7 +566,10 @@ class Workflow(BaseWorkflow[TWorkflowInput]):
         wait_for: list[Condition | OrGroup] = [],
         skip_if: list[Condition | OrGroup] = [],
         cancel_if: list[Condition | OrGroup] = [],
-    ) -> Callable[[Callable[[TWorkflowInput, Context], R]], Task[TWorkflowInput, R]]:
+    ) -> Callable[
+        [Callable[[TWorkflowInput, Context], R | CoroutineLike[R]]],
+        Task[TWorkflowInput, R],
+    ]:
         """
         A decorator to transform a function into a Hatchet task that runs as part of a workflow.
 
@@ -640,7 +612,7 @@ class Workflow(BaseWorkflow[TWorkflowInput]):
         )
 
         def inner(
-            func: Callable[[TWorkflowInput, Context], R]
+            func: Callable[[TWorkflowInput, Context], R | CoroutineLike[R]],
         ) -> Task[TWorkflowInput, R]:
             task = Task(
                 _fn=func,
@@ -687,7 +659,8 @@ class Workflow(BaseWorkflow[TWorkflowInput]):
         skip_if: list[Condition | OrGroup] = [],
         cancel_if: list[Condition | OrGroup] = [],
     ) -> Callable[
-        [Callable[[TWorkflowInput, DurableContext], R]], Task[TWorkflowInput, R]
+        [Callable[[TWorkflowInput, DurableContext], R | CoroutineLike[R]]],
+        Task[TWorkflowInput, R],
     ]:
         """
         A decorator to transform a function into a durable Hatchet task that runs as part of a workflow.
@@ -735,7 +708,7 @@ class Workflow(BaseWorkflow[TWorkflowInput]):
         )
 
         def inner(
-            func: Callable[[TWorkflowInput, DurableContext], R]
+            func: Callable[[TWorkflowInput, DurableContext], R | CoroutineLike[R]],
         ) -> Task[TWorkflowInput, R]:
             task = Task(
                 _fn=func,
@@ -776,7 +749,10 @@ class Workflow(BaseWorkflow[TWorkflowInput]):
         backoff_factor: float | None = None,
         backoff_max_seconds: int | None = None,
         concurrency: list[ConcurrencyExpression] = [],
-    ) -> Callable[[Callable[[TWorkflowInput, Context], R]], Task[TWorkflowInput, R]]:
+    ) -> Callable[
+        [Callable[[TWorkflowInput, Context], R | CoroutineLike[R]]],
+        Task[TWorkflowInput, R],
+    ]:
         """
         A decorator to transform a function into a Hatchet on-failure task that runs as the last step in a workflow that had at least one task fail.
 
@@ -800,7 +776,7 @@ class Workflow(BaseWorkflow[TWorkflowInput]):
         """
 
         def inner(
-            func: Callable[[TWorkflowInput, Context], R]
+            func: Callable[[TWorkflowInput, Context], R | CoroutineLike[R]],
         ) -> Task[TWorkflowInput, R]:
             task = Task(
                 is_durable=False,
@@ -836,7 +812,10 @@ class Workflow(BaseWorkflow[TWorkflowInput]):
         backoff_factor: float | None = None,
         backoff_max_seconds: int | None = None,
         concurrency: list[ConcurrencyExpression] = [],
-    ) -> Callable[[Callable[[TWorkflowInput, Context], R]], Task[TWorkflowInput, R]]:
+    ) -> Callable[
+        [Callable[[TWorkflowInput, Context], R | CoroutineLike[R]]],
+        Task[TWorkflowInput, R],
+    ]:
         """
         A decorator to transform a function into a Hatchet on-success task that runs as the last step in a workflow that had all upstream tasks succeed.
 
@@ -860,7 +839,7 @@ class Workflow(BaseWorkflow[TWorkflowInput]):
         """
 
         def inner(
-            func: Callable[[TWorkflowInput, Context], R]
+            func: Callable[[TWorkflowInput, Context], R | CoroutineLike[R]],
         ) -> Task[TWorkflowInput, R]:
             task = Task(
                 is_durable=False,

hatchet_sdk-1.9.0/hatchet_sdk/utils/typing.py

@@ -0,0 +1,39 @@
+import sys
+from typing import (
+    Any,
+    Awaitable,
+    Coroutine,
+    Generator,
+    Mapping,
+    Type,
+    TypeAlias,
+    TypeGuard,
+    TypeVar,
+)
+
+from pydantic import BaseModel
+
+
+def is_basemodel_subclass(model: Any) -> TypeGuard[Type[BaseModel]]:
+    try:
+        return issubclass(model, BaseModel)
+    except TypeError:
+        return False
+
+
+class TaskIOValidator(BaseModel):
+    workflow_input: Type[BaseModel] | None = None
+    step_output: Type[BaseModel] | None = None
+
+
+JSONSerializableMapping = Mapping[str, Any]
+
+
+_T_co = TypeVar("_T_co", covariant=True)
+
+if sys.version_info >= (3, 12):
+    AwaitableLike: TypeAlias = Awaitable[_T_co]  # noqa: Y047
+    CoroutineLike: TypeAlias = Coroutine[Any, Any, _T_co]  # noqa: Y047
+else:
+    AwaitableLike: TypeAlias = Generator[Any, None, _T_co] | Awaitable[_T_co]
+    CoroutineLike: TypeAlias = Generator[Any, None, _T_co] | Coroutine[Any, Any, _T_co]

{hatchet_sdk-1.8.1 → hatchet_sdk-1.9.0}/hatchet_sdk/worker/action_listener_process.py

@@ -291,6 +291,9 @@ class WorkerActionListenerProcess:
         self.event_queue.put(STOP_LOOP)
 
     async def exit_gracefully(self) -> None:
+        if self.listener:
+            self.listener.stop_signal = True
+
         await self.pause_task_assignment()
 
         if self.killing:

{hatchet_sdk-1.8.1 → hatchet_sdk-1.9.0}/hatchet_sdk/worker/runner/runner.py

@@ -105,6 +105,9 @@ class Runner:
 
         self.lifespan_context = lifespan_context
 
+        if self.config.enable_thread_pool_monitoring:
+            self.start_background_monitoring()
+
     def create_workflow_run_url(self, action: Action) -> str:
         return f"{self.config.server_url}/workflow-runs/{action.workflow_run_id}?tenant={action.tenant_id}"
 
@@ -270,6 +273,47 @@ class Runner:
         finally:
             self.cleanup_run_id(action.key)
 
+    async def log_thread_pool_status(self) -> None:
+        thread_pool_details = {
+            "max_workers": self.slots,
+            "total_threads": len(self.thread_pool._threads),
+            "idle_threads": self.thread_pool._idle_semaphore._value,
+            "active_threads": len(self.threads),
+            "pending_tasks": len(self.tasks),
+            "queue_size": self.thread_pool._work_queue.qsize(),
+            "threads_alive": sum(1 for t in self.thread_pool._threads if t.is_alive()),
+            "threads_daemon": sum(1 for t in self.thread_pool._threads if t.daemon),
+        }
+
+        logger.warning("Thread pool detailed status %s", thread_pool_details)
+
+    async def _start_monitoring(self) -> None:
+        logger.debug("Thread pool monitoring started")
+        try:
+            while True:
+                await self.log_thread_pool_status()
+
+                for key in self.threads.keys():
+                    if key not in self.tasks:
+                        logger.debug(f"Potential zombie thread found for key {key}")
+
+                for key, task in self.tasks.items():
+                    if task.done() and key in self.threads:
+                        logger.debug(
+                            f"Task is done but thread still exists for key {key}"
+                        )
+
+                await asyncio.sleep(60)
+        except asyncio.CancelledError:
+            logger.warning("Thread pool monitoring task cancelled")
+        except Exception as e:
+            logger.exception(f"Error in thread pool monitoring: {e}")
+
+    def start_background_monitoring(self) -> None:
+        loop = asyncio.get_event_loop()
+        self.monitoring_task = loop.create_task(self._start_monitoring())
+        logger.debug("Started thread pool monitoring background task")
+
     def cleanup_run_id(self, key: ActionKey) -> None:
         if key in self.tasks:
             del self.tasks[key]
@@ -419,23 +463,18 @@ class Runner:
         try:
             # call cancel to signal the context to stop
             if key in self.contexts:
-                context = self.contexts.get(key)
-
-                if context:
-                    context._set_cancellation_flag()
+                self.contexts[key]._set_cancellation_flag()
 
             await asyncio.sleep(1)
 
             if key in self.tasks:
-                future = self.tasks.get(key)
-
-                if future:
-                    future.cancel()
+                self.tasks[key].cancel()
 
             # check if thread is still running, if so, print a warning
             if key in self.threads:
-                thread = self.threads.get(key)
-                if thread and self.config.enable_force_kill_sync_threads:
+                thread = self.threads[key]
+
+                if self.config.enable_force_kill_sync_threads:
                     self.force_kill_thread(thread)
                     await asyncio.sleep(1)
 

{hatchet_sdk-1.8.1 → hatchet_sdk-1.9.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "hatchet-sdk"
-version = "1.8.1"
+version = "1.9.0"
 description = ""
 authors = ["Alexander Belanger <alexander@hatchet.run>"]
 readme = "README.md"

hatchet_sdk-1.8.1/hatchet_sdk/utils/typing.py

@@ -1,18 +0,0 @@
-from typing import Any, Mapping, Type, TypeGuard
-
-from pydantic import BaseModel
-
-
-def is_basemodel_subclass(model: Any) -> TypeGuard[Type[BaseModel]]:
-    try:
-        return issubclass(model, BaseModel)
-    except TypeError:
-        return False
-
-
-class TaskIOValidator(BaseModel):
-    workflow_input: Type[BaseModel] | None = None
-    step_output: Type[BaseModel] | None = None
-
-
-JSONSerializableMapping = Mapping[str, Any]