fix: handle empty trigger responses

Author: radu-mocanu

pyproject.toml

@@ -1,11 +1,12 @@
 [project]
 name = "uipath"
-version = "2.2.24"
+version = "2.2.25"
 description = "Python SDK and CLI for UiPath Platform, enabling programmatic interaction with automation services, process management, and deployment tools."
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.11"
 dependencies = [
   "uipath-runtime>=0.2.3, <0.3.0",
+  "uipath-core>=0.1.0, <0.2.0",
   "click>=8.3.1",
   "httpx>=0.28.1",
   "pyjwt>=2.10.1",
@@ -126,9 +127,9 @@ init_typed = true
 warn_required_dynamic_aliases = true
 
 [tool.pytest.ini_options]
-testpaths = ["tests"]
-python_files = "test_*.py"
-addopts = "-ra -q --cov"
+#testpaths = ["tests"]
+#python_files = "test_*.py"
+#addopts = "-ra -q --cov"
 asyncio_default_fixture_loop_scope = "function"
 asyncio_mode = "auto"
 

src/uipath/platform/resume_triggers/__init__.py

@@ -1,5 +1,6 @@
 """Init file for resume triggers module."""
 
+from ._enums import PropertyName, TriggerMarker
 from ._protocol import (
     UiPathResumeTriggerCreator,
     UiPathResumeTriggerHandler,
@@ -10,4 +11,6 @@
     "UiPathResumeTriggerReader",
     "UiPathResumeTriggerCreator",
     "UiPathResumeTriggerHandler",
+    "PropertyName",
+    "TriggerMarker",
 ]

src/uipath/platform/resume_triggers/_enums.py

@@ -0,0 +1,18 @@
+"""UiPath resume trigger enums."""
+
+from enum import Enum
+
+
+class PropertyName(str, Enum):
+    """UiPath trigger property names."""
+
+    INTERNAL = "__internal"
+
+
+class TriggerMarker(str, Enum):
+    """UiPath trigger markers.
+
+    These markers are used as properties of resume triggers objects for special handling at runtime.
+    """
+
+    NO_CONTENT = "NO_CONTENT"

src/uipath/platform/resume_triggers/_protocol.py

@@ -29,9 +29,10 @@
     WaitTask,
 )
 from uipath.platform.orchestrator.job import JobState
+from uipath.platform.resume_triggers._enums import PropertyName, TriggerMarker
 
 
-def _try_convert_to_json_format(value: str | None) -> str | None:
+def _try_convert_to_json_format(value: str | None) -> Any:
     """Attempts to parse a string as JSON and returns the parsed object or original string.
 
     Args:
@@ -119,7 +120,16 @@ async def read_trigger(self, trigger: UiPathResumeTrigger) -> Any | None:
                     if trigger.trigger_name == UiPathResumeTriggerName.ESCALATION:
                         return task
 
-                    return task.data
+                    trigger_response = task.data
+                    if not bool(trigger_response):
+                        # 2.3.0 change to task.status.name
+                        assert isinstance(task.status, int)
+                        trigger_response = {
+                            "status": TaskStatus(task.status).name.lower(),
+                            PropertyName.INTERNAL.value: TriggerMarker.NO_CONTENT.value,
+                        }
+
+                    return trigger_response
 
             case UiPathResumeTriggerType.JOB:
                 if trigger.item_key:
@@ -161,7 +171,10 @@ async def read_trigger(self, trigger: UiPathResumeTrigger) -> Any | None:
                         trigger_response
                     ):
                         # 2.3.0 change to job_state.value
-                        return {"state": job_state}
+                        trigger_response = {
+                            "state": job_state,
+                            PropertyName.INTERNAL.value: TriggerMarker.NO_CONTENT.value,
+                        }
 
                     return trigger_response
 
@@ -255,7 +268,6 @@ async def create_trigger(self, suspend_value: Any) -> UiPathResumeTrigger:
                 "Failed to create HITL action",
                 f"{str(e)}",
             ) from e
-
         return resume_trigger
 
     def _determine_trigger_type(self, value: Any) -> UiPathResumeTriggerType:

tests/cli/test_hitl.py

@@ -1,4 +1,5 @@
 import uuid
+from typing import Any
 from unittest.mock import AsyncMock, patch
 
 import pytest
@@ -12,12 +13,15 @@
 )
 
 from uipath.platform.action_center import Task
+from uipath.platform.action_center.tasks import TaskStatus
 from uipath.platform.common import CreateTask, InvokeProcess, WaitJob, WaitTask
 from uipath.platform.orchestrator import (
     Job,
     JobErrorInfo,
 )
 from uipath.platform.resume_triggers import (
+    PropertyName,
+    TriggerMarker,
     UiPathResumeTriggerCreator,
     UiPathResumeTriggerReader,
 )
@@ -41,7 +45,7 @@ class TestHitlReader:
     """Tests for the HitlReader class."""
 
     @pytest.mark.anyio
-    async def test_read_action_trigger(
+    async def test_read_task_trigger(
         self,
         setup_test_env: None,
     ) -> None:
@@ -72,6 +76,41 @@ async def test_read_action_trigger(
                 app_name=None,
             )
 
+    @pytest.mark.anyio
+    async def test_read_task_trigger_empty_response(
+        self,
+        setup_test_env: None,
+    ) -> None:
+        """Test reading an action trigger."""
+        action_key = "test-action-key"
+        action_data: dict[str, Any] = {}
+
+        mock_task = Task(key=action_key, data=action_data, status=2)
+        mock_retrieve_async = AsyncMock(return_value=mock_task)
+
+        with patch(
+            "uipath.platform.action_center._tasks_service.TasksService.retrieve_async",
+            new=mock_retrieve_async,
+        ):
+            resume_trigger = UiPathResumeTrigger(
+                trigger_type=UiPathResumeTriggerType.TASK,
+                item_key=action_key,
+                folder_key="test-folder",
+                folder_path="test-path",
+            )
+            reader = UiPathResumeTriggerReader()
+            result = await reader.read_trigger(resume_trigger)
+            assert result == {
+                "status": TaskStatus(2).name.lower(),
+                PropertyName.INTERNAL.value: TriggerMarker.NO_CONTENT.value,
+            }
+            mock_retrieve_async.assert_called_once_with(
+                action_key,
+                app_folder_key="test-folder",
+                app_folder_path="test-path",
+                app_name=None,
+            )
+
     @pytest.mark.anyio
     async def test_read_job_trigger_successful(
         self,
@@ -140,7 +179,10 @@ async def test_read_job_trigger_successful_empty_output(
             )
             reader = UiPathResumeTriggerReader()
             result = await reader.read_trigger(resume_trigger)
-            assert result == {"state": job_state.lower()}
+            assert result == {
+                "state": job_state.lower(),
+                PropertyName.INTERNAL.value: TriggerMarker.NO_CONTENT.value,
+            }
             mock_retrieve_async.assert_called_once_with(
                 job_key,
                 folder_key="test-folder",