fix: register sdk interrupt models with msgpack allowlist (#1500)

Author: radu-mocanu

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath-langchain"
-version = "0.10.10"
+version = "0.10.11"
 description = "Python SDK that enables developers to build and deploy LangGraph agents to the UiPath Cloud Platform"
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.11"

src/uipath_langchain/runtime/__init__.py

@@ -4,6 +4,9 @@
     UiPathRuntimeFactoryRegistry,
 )
 
+from uipath_langchain.runtime._msgpack_registry import (
+    register_uipath_interrupt_models_with_msgpack,
+)
 from uipath_langchain.runtime.factory import UiPathLangGraphRuntimeFactory
 from uipath_langchain.runtime.runtime import UiPathLangGraphRuntime
 from uipath_langchain.runtime.schema import (
@@ -14,6 +17,7 @@
 
 def register_runtime_factory() -> None:
     """Register the LangGraph factory. Called automatically via entry point."""
+    register_uipath_interrupt_models_with_msgpack()
 
     def create_factory(
         context: UiPathRuntimeContext | None = None,

src/uipath_langchain/runtime/_msgpack_registry.py

@@ -0,0 +1,22 @@
+"""Add UiPath SDK interrupt models to langgraph's msgpack safe-types set."""
+
+from __future__ import annotations
+
+import inspect
+
+
+def register_uipath_interrupt_models_with_msgpack() -> None:
+    """Allowlist every class in `uipath.platform.common.interrupt_models`.
+
+    Without this, langgraph emits an `unregistered type` warning whenever a
+    checkpoint containing an SDK interrupt model (e.g. `CreateTask`) is loaded.
+    """
+    from langgraph.checkpoint.serde import _msgpack as _lg_msgpack
+    from uipath.platform.common import interrupt_models
+
+    extras = {
+        (cls.__module__, cls.__name__)
+        for _, cls in inspect.getmembers(interrupt_models, inspect.isclass)
+        if cls.__module__ == interrupt_models.__name__
+    }
+    _lg_msgpack.SAFE_MSGPACK_TYPES = frozenset(_lg_msgpack.SAFE_MSGPACK_TYPES | extras)

tests/runtime/test_msgpack_registry.py

@@ -0,0 +1,65 @@
+"""Verify SDK interrupt models are registered with langgraph's msgpack allowlist."""
+
+from __future__ import annotations
+
+import logging
+
+from langgraph.checkpoint.serde import _msgpack as _lg_msgpack
+from langgraph.checkpoint.serde.jsonplus import JsonPlusSerializer
+from uipath.platform.common.interrupt_models import CreateTask
+
+from uipath_langchain.runtime._msgpack_registry import (
+    register_uipath_interrupt_models_with_msgpack,
+)
+
+
+def test_create_task_is_in_safe_msgpack_types() -> None:
+    register_uipath_interrupt_models_with_msgpack()
+
+    assert (
+        "uipath.platform.common.interrupt_models",
+        "CreateTask",
+    ) in _lg_msgpack.SAFE_MSGPACK_TYPES
+
+
+def test_all_interrupt_models_registered() -> None:
+    """Every public class in interrupt_models should be auto-registered."""
+    register_uipath_interrupt_models_with_msgpack()
+
+    from uipath.platform.common import interrupt_models
+
+    for name in [
+        "CreateTask",
+        "CreateEscalation",
+        "WaitTask",
+        "InvokeProcess",
+        "WaitJob",
+        "CreateBatchTransform",
+    ]:
+        assert hasattr(interrupt_models, name)
+        assert (
+            interrupt_models.__name__,
+            name,
+        ) in _lg_msgpack.SAFE_MSGPACK_TYPES
+
+
+def test_round_trip_create_task_emits_no_warning(
+    caplog: logging.LogRecord,
+) -> None:
+    """Deserializing a CreateTask checkpoint must not warn about unregistered types."""
+    register_uipath_interrupt_models_with_msgpack()
+
+    serde = JsonPlusSerializer()
+    task = CreateTask(title="hello", data={})
+    type_, payload = serde.dumps_typed(task)
+
+    with caplog.at_level(  # type: ignore[attr-defined]
+        logging.WARNING, logger="langgraph.checkpoint.serde.jsonplus"
+    ):
+        restored = serde.loads_typed((type_, payload))
+
+    assert isinstance(restored, CreateTask)
+    assert all(
+        "Deserializing unregistered type" not in record.message
+        for record in caplog.records  # type: ignore[attr-defined]
+    )