fix(platform): preserve interrupt model compatibility

Author: andreiancuta-uipath

packages/uipath-platform/src/uipath/platform/common/__init__.py

@@ -194,7 +194,7 @@ def __getattr__(name: str) -> Any:
 
     from . import interrupt_models
 
-    value = getattr(interrupt_models, name)
+    value = interrupt_models._resolve(name)
     globals()[name] = value
     return value
 

packages/uipath-platform/src/uipath/platform/common/interrupt_models.py

@@ -63,31 +63,34 @@
     "WaitUntil",
 ]
 
-_warning_emitted = False
 
+def _resolve(name: str) -> Any:
+    """Resolve a deprecated alias from the canonical module and warn.
 
-def __getattr__(name: str) -> Any:
-    """Resolve deprecated interrupt model aliases on demand."""
-    if name not in __all__:
-        raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
-
+    Called only from a module ``__getattr__`` (here or in ``common``), so the
+    frame three levels up from ``warnings.warn`` is the user's import site.
+    """
     import uipath.platform.resume_triggers.interrupt_models as canonical_models
 
     value = getattr(canonical_models, name)
-    global _warning_emitted
-    if not _warning_emitted:
-        warnings.warn(
-            "Interrupt models from uipath.platform.common are deprecated and will "
-            "be removed in a future release; import from "
-            "uipath.platform.resume_triggers instead.",
-            FutureWarning,
-            stacklevel=2,
-        )
-        _warning_emitted = True
+    warnings.warn(
+        "Importing interrupt models from uipath.platform.common is deprecated "
+        "and will be removed in a future release; import from "
+        "uipath.platform.resume_triggers instead.",
+        DeprecationWarning,
+        stacklevel=3,
+    )
     globals()[name] = value
     return value
 
 
+def __getattr__(name: str) -> Any:
+    """Resolve deprecated interrupt model aliases on demand."""
+    if name not in __all__:
+        raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+    return _resolve(name)
+
+
 def __dir__() -> list[str]:
     """List compatibility exports."""
     return sorted(set(globals()) | set(__all__))

packages/uipath-platform/tests/common/test_interrupt_models_compatibility.py

@@ -54,23 +54,15 @@ def test_compatibility_exports_are_canonical_objects():
     common = importlib.import_module("uipath.platform.common")
     legacy = importlib.import_module("uipath.platform.common.interrupt_models")
 
-    with warnings.catch_warnings(record=True) as caught:
-        warnings.simplefilter("always")
+    with warnings.catch_warnings():
+        warnings.simplefilter("ignore", DeprecationWarning)
         for name in INTERRUPT_MODEL_NAMES:
-            canonical_model = getattr(canonical, name)
-            assert getattr(legacy, name) is canonical_model
-            assert getattr(common, name) is canonical_model
-
-    compatibility_warnings = [
-        warning
-        for warning in caught
-        if issubclass(warning.category, FutureWarning)
-        and "uipath.platform.resume_triggers" in str(warning.message)
-    ]
-    assert len(compatibility_warnings) == 1
+            assert getattr(legacy, name) is getattr(canonical, name)
+            assert getattr(common, name) is getattr(canonical, name)
+
     assert set(INTERRUPT_MODEL_NAMES) == set(legacy.__all__)
     assert set(INTERRUPT_MODEL_NAMES) <= set(common.__all__)
-    assert set(INTERRUPT_MODEL_NAMES) <= set(dir(legacy))
+    assert set(legacy.__all__) <= set(dir(legacy))
     assert set(INTERRUPT_MODEL_NAMES) <= set(dir(common))
 
 
@@ -86,7 +78,7 @@ def test_importing_common_does_not_load_resume_triggers_or_warn():
 
 assert "uipath.platform.resume_triggers" not in sys.modules
 assert "uipath.platform.resume_triggers.interrupt_models" not in sys.modules
-assert not [item for item in caught if issubclass(item.category, FutureWarning)]
+assert not [item for item in caught if issubclass(item.category, DeprecationWarning)]
 """
     )
 
@@ -120,35 +112,72 @@ def test_import_orders_are_cycle_safe(imports: str):
 compatibility_warnings = [
     item
     for item in caught
-    if issubclass(item.category, FutureWarning)
+    if issubclass(item.category, DeprecationWarning)
     and "uipath.platform.resume_triggers" in str(item.message)
 ]
-assert len(compatibility_warnings) == 1
+assert compatibility_warnings
 """
     )
 
 
-def test_only_first_legacy_model_resolution_warns():
+def test_legacy_imports_warn_at_caller_site():
     _run_python(
         """
-import importlib
 import warnings
 
-common = importlib.import_module("uipath.platform.common")
-legacy = importlib.import_module("uipath.platform.common.interrupt_models")
+with warnings.catch_warnings(record=True) as caught:
+    warnings.simplefilter("always")
+    from uipath.platform.common import WaitUntil
+    from uipath.platform.common.interrupt_models import WaitTask
+
+compatibility_warnings = [
+    item
+    for item in caught
+    if issubclass(item.category, DeprecationWarning)
+    and "uipath.platform.resume_triggers" in str(item.message)
+]
+assert len(compatibility_warnings) == 2
+assert all(item.filename == "<string>" for item in compatibility_warnings), [
+    item.filename for item in compatibility_warnings
+]
+"""
+    )
+
+
+def test_cached_resolution_warns_once_per_name():
+    _run_python(
+        """
+import warnings
+
+import uipath.platform.common as common
 
 with warnings.catch_warnings(record=True) as caught:
     warnings.simplefilter("always")
-    legacy.WaitUntil
-    legacy.WaitTask
+    common.WaitUntil
+    common.WaitUntil
     common.WaitJob
 
 compatibility_warnings = [
     item
     for item in caught
-    if issubclass(item.category, FutureWarning)
+    if issubclass(item.category, DeprecationWarning)
     and "uipath.platform.resume_triggers" in str(item.message)
 ]
-assert len(compatibility_warnings) == 1
+assert len(compatibility_warnings) == 2
+"""
+    )
+
+
+def test_star_import_exports_all_interrupt_models():
+    _run_python(
+        """
+import warnings
+
+warnings.simplefilter("ignore", DeprecationWarning)
+
+from uipath.platform.common.interrupt_models import *  # noqa: F403
+
+for name in ("InvokeProcess", "WaitUntil", "CreateTask", "WaitIntegrationEvent"):
+    assert name in globals(), name
 """
     )