Merge pull request #105 from UiPath/feat/add-support-for-inbox-triggers

feat: support for IS resume triggers

Author: GabrielVasilescu04

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath-runtime"
-version = "0.10.2"
+version = "0.10.3"
 description = "Runtime abstractions and interfaces for building agents and automation scripts in the UiPath ecosystem"
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.11"

src/uipath/runtime/__init__.py

@@ -2,6 +2,7 @@
 
 from uipath.core.triggers import (
     UiPathApiTrigger,
+    UiPathIntegrationTrigger,
     UiPathResumeTrigger,
     UiPathResumeTriggerName,
     UiPathResumeTriggerType,
@@ -60,6 +61,7 @@
     "UiPathResumableStorageProtocol",
     "UiPathResumeTriggerProtocol",
     "UiPathApiTrigger",
+    "UiPathIntegrationTrigger",
     "UiPathResumeTrigger",
     "UiPathResumeTriggerType",
     "UiPathResumableRuntime",

src/uipath/runtime/resumable/__init__.py

@@ -2,6 +2,7 @@
 
 from uipath.core.triggers import (
     UiPathApiTrigger,
+    UiPathIntegrationTrigger,
     UiPathResumeTrigger,
     UiPathResumeTriggerType,
 )
@@ -19,6 +20,7 @@
     "UiPathResumeTriggerReaderProtocol",
     "UiPathResumeTriggerProtocol",
     "UiPathApiTrigger",
+    "UiPathIntegrationTrigger",
     "UiPathResumeTrigger",
     "UiPathResumeTriggerType",
 ]

src/uipath/runtime/resumable/runtime.py

@@ -145,9 +145,10 @@ async def stream(
                     options.resume = True
 
     async def _get_fired_triggers(self) -> dict[str, Any] | None:
-        """Check stored triggers for any that have already fired (excluding API triggers).
+        """Check stored triggers for any that have already fired.
 
-        API triggers cannot be completed before suspending the job, so they are skipped.
+        Skips async-external triggers (API, Inbox) whose payloads only arrive
+        asynchronously and cannot be polled at suspend time.
 
         Returns:
             A resume map of {interrupt_id: resume_data} for fired triggers, or None.
@@ -156,10 +157,13 @@ async def _get_fired_triggers(self) -> dict[str, Any] | None:
         if not triggers:
             return None
 
-        non_api_triggers = [
-            t for t in triggers if t.trigger_type != UiPathResumeTriggerType.API
+        pollable_triggers = [
+            t
+            for t in triggers
+            if t.trigger_type
+            not in (UiPathResumeTriggerType.API, UiPathResumeTriggerType.INBOX)
         ]
-        return await self._build_resume_map(non_api_triggers)
+        return await self._build_resume_map(pollable_triggers)
 
     async def _restore_resume_input(
         self,

src/uipath/runtime/resumable/trigger.py

@@ -2,13 +2,15 @@
 
 from uipath.core.triggers import (
     UiPathApiTrigger,
+    UiPathIntegrationTrigger,
     UiPathResumeTrigger,
     UiPathResumeTriggerName,
     UiPathResumeTriggerType,
 )
 
 __all__ = [
     "UiPathApiTrigger",
+    "UiPathIntegrationTrigger",
     "UiPathResumeTrigger",
     "UiPathResumeTriggerName",
     "UiPathResumeTriggerType",

tests/test_resumable.py

@@ -499,6 +499,55 @@ async def read_trigger_impl(trigger: UiPathResumeTrigger) -> dict[str, Any]:
         # Delegate should have been executed only once (no auto-resume)
         assert runtime_impl.execution_count == 1
 
+    @pytest.mark.asyncio
+    async def test_resumable_skips_inbox_triggers_on_auto_resume_check(self) -> None:
+        """Inbox triggers should be skipped when checking for auto-resume after suspension.
+
+        Inbox triggers are async-external (payload delivered via Integration
+        Services), so calling read_trigger on them at suspend time would hit a
+        404 and fault the run. They should behave like API triggers here.
+        """
+
+        runtime_impl = MultiTriggerMockRuntime()
+        storage = StatefulStorageMock()
+        trigger_manager = make_trigger_manager_mock()
+
+        def create_inbox_trigger(data: dict[str, Any]) -> UiPathResumeTrigger:
+            return UiPathResumeTrigger(
+                interrupt_id="",  # Will be set by resumable runtime
+                trigger_type=UiPathResumeTriggerType.INBOX,
+                payload=data,
+            )
+
+        trigger_manager.create_trigger = AsyncMock(side_effect=create_inbox_trigger)  # type: ignore[method-assign]
+
+        # Track whether read_trigger is ever called — it must NOT be, otherwise
+        # the filter is broken and we'd hit the payload endpoint prematurely.
+        read_trigger_guard = AsyncMock(
+            side_effect=AssertionError(
+                "read_trigger must not be called for Inbox triggers pre-resume"
+            )
+        )
+        trigger_manager.read_trigger = read_trigger_guard  # type: ignore[method-assign]
+
+        resumable = UiPathResumableRuntime(
+            delegate=runtime_impl,
+            storage=storage,
+            trigger_manager=trigger_manager,
+            runtime_id="runtime-1",
+        )
+
+        result = await resumable.execute({})
+
+        assert result.status == UiPathRuntimeStatus.SUSPENDED
+        assert result.triggers is not None
+        assert len(result.triggers) == 2
+        assert all(
+            t.trigger_type == UiPathResumeTriggerType.INBOX for t in result.triggers
+        )
+        trigger_manager.read_trigger.assert_not_called()
+        assert runtime_impl.execution_count == 1
+
     @pytest.mark.asyncio
     async def test_resumable_auto_resumes_task_triggers_but_not_api_triggers(
         self,