Add initial remote debugging support and update related components

- Introduced remote debugging capabilities with debugpy.
- Updated changelog to reflect new feature.
- Added debugpy dependency in pyproject.toml and requirements-dev.txt.
- Integrated debugpy initialization in business operation, process, and service classes.
- Enhanced test cases to accommodate debugging features.

Author: grongierisc

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Add namespace selection in the `iop` command
   - `-n` or `--namespace` option to select a namespace
+- Initial remote debugging support
 
 ### Changed
 - Change how `iris` module is loaded

pyproject.toml

@@ -31,7 +31,8 @@ dependencies = [
     "xmltodict>=0.12.0",
     "iris-embedded-python-wrapper>=0.0.6",
     "setuptools>=40.8.0",
-    "jsonpath-ng>=1.7.0"
+    "jsonpath-ng>=1.7.0",
+    "debugpy>=1.8.0",
 ]
 
 license = { file = "LICENSE" }

requirements-dev.txt

@@ -9,4 +9,5 @@ iris-embedded-python-wrapper
 jsonpath-ng
 pydantic>=2.0.0
 mkdocs
-pymdown-extensions
+pymdown-extensions
+debugpy

src/iop/_business_operation.py

@@ -47,6 +47,7 @@ def _set_iris_handles(self, handle_current: Any, handle_partner: Any) -> None:
 
     def _dispatch_on_init(self, host_object: Any) -> None:
         """For internal use only."""
+        self._debugpy(host_object=host_object)
         create_dispatch(self)
         self.on_init()
         return

src/iop/_business_process.py

@@ -141,6 +141,7 @@ def _dispatch_on_connected(self, host_object: Any) -> None:
     def _dispatch_on_init(self, host_object: Any) -> None:
         """For internal use only."""
         self._restore_persistent_properties(host_object)
+        self._debugpy(host_object=host_object)
         create_dispatch(self)
         self.on_init()
         self._save_persistent_properties(host_object)

src/iop/_business_service.py

@@ -16,6 +16,15 @@ class _BusinessService(_BusinessHost):
     Adapter = adapter = None
     _wait_for_next_call_interval = False
 
+    def _dispatch_on_init(self, host_object) -> None:
+        """For internal use only."""
+
+        self._debugpy(host_object=host_object)
+
+        self.on_init()
+
+        return
+
     def on_process_input(self, message_input):
         """ Receives the message from the inbond adapter via the PRocessInput method and is responsible for forwarding it to target business processes or operations.
         If the business service does not specify an adapter, then the default adapter calls this method with no message 

src/iop/_common.py

@@ -1,6 +1,7 @@
 import abc
 import inspect
 import traceback
+
 from typing import Any, ClassVar, List, Optional, Tuple
 
 from . import _iris
@@ -57,8 +58,79 @@ def _dispatch_on_connected(self, host_object: Any) -> None:
         self.on_connected()
 
     def _dispatch_on_init(self, host_object: Any) -> None:
+        """Initialize component when started."""
+        self._debugpy(host_object)
         self.on_init()
 
+    def _debugpy(self, host_object: Any) -> None:
+        """Enable debugpy for debugging purposes."""
+        # iris.cls('%SYS.Python').Debugging(1)
+        from iop._debugpy import enable_debugpy, wait_for_debugpy_connected, find_free_port, is_debugpy_installed
+        import sys, os
+
+        # hack to set __file__ for os module in debugpy
+        # This is a workaround for the issue where debugpy cannot find the __file__ attribute of the os module.
+        if not hasattr(os, '__file__'):
+            setattr(os, '__file__', __file__)
+
+        if host_object is not None:
+            port = host_object.port
+            timeout = host_object.timeout
+            enabled = host_object.enable
+            python_interpreter_path = host_object.PythonInterpreterPath
+        else:
+            self.log_alert("No host object found, cannot enable debugpy.")
+            return
+        
+        if python_interpreter_path != "":
+            # the user has set a specific python interpreter path, so we need to set the path to the python executable
+            # to the one that is running this script
+            if os.path.exists(python_interpreter_path):
+                sys.executable = python_interpreter_path
+            else:
+                self.log_alert(f"Python path {python_interpreter_path} does not exist, cannot set python path for debugpy.")
+                return
+        elif sys.executable.find('irisdb') > 0:
+            # the executable is the IRIS executable, so we need to set the path to the python executable
+            # to the one that is running this script
+            installdir = os.environ.get('IRISINSTALLDIR') or os.environ.get('ISC_PACKAGE_INSTALLDIR')
+            if installdir is not None:
+                if sys.platform == 'win32':
+                    python_path = os.path.join(installdir, 'bin', 'irispython.exe')
+                else:
+                    python_path = os.path.join(installdir, 'bin', 'irispython')
+                if os.path.exists(python_path):
+                    sys.executable = python_path
+                else:
+                    self.log_alert(f"Python path {python_path} does not exist, cannot set python path for debugpy.")
+                    return
+            else:
+                self.log_alert("IRISINSTALLDIR or ISC_PACKAGE_INSTALLDIR not set, cannot set python path for debugpy.")
+                return
+
+        if enabled:
+            self.log_info(f"Debugpy is running in {sys.executable}.")
+            if is_debugpy_installed():
+                if port is None or port <= 0:
+                    port = find_free_port()
+                self.log_info(f"Debugpy enabled.")
+                try:
+                    enable_debugpy(port=port, address=None)
+                except Exception as e:
+                    self.log_alert(f"Error enabling debugpy: {e}")
+                    return
+
+                self.trace(f"Waiting for {timeout} sec to debugpy connection on port {port}...")
+                if wait_for_debugpy_connected(timeout=timeout, port=port):
+                    self.log_info("Debugpy connected.")
+                else:
+                    self.log_alert(f"Debugpy connection timed out after {timeout} seconds.")
+            else:
+                self.log_alert("Debugpy is not installed.")
+        else:
+            self.log_info("Debugpy is not enabled.")
+
+
     def _dispatch_on_tear_down(self, host_object: Any) -> None:
         self.on_tear_down()
 

src/iop/_debugpy.py

@@ -0,0 +1,69 @@
+
+import threading
+import time
+import contextlib
+import socket
+from contextlib import closing
+
+from typing import Optional, Tuple, Union, Sequence, cast, Callable, TypeVar, Dict, Any
+
+def find_free_port(start: Optional[int] = None, end: Optional[int] = None) -> int:
+    port = start
+    if port is None:
+        port = 0
+    if end is None:
+        end = port
+
+    try:
+        with closing(socket.socket(socket.AF_INET, socket.SOCK_STREAM)) as s:
+            with contextlib.suppress(Exception):
+                s.setsockopt(socket.IPPROTO_IPV6, socket.IPV6_V6ONLY, 0)
+
+            s.bind(("0.0.0.0", port))
+
+            s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
+            return cast(int, s.getsockname()[1])
+    except (SystemExit, KeyboardInterrupt):
+        raise
+    except BaseException:
+        if port and end > port:
+            return find_free_port(port + 1, end)
+        if start and start > 0:
+            return find_free_port(None)
+        raise
+
+
+def is_debugpy_installed() -> bool:
+    try:
+        __import__("debugpy")
+    except ImportError:
+        return False
+    return True
+
+
+def wait_for_debugpy_connected(timeout: float = 30,port=0) -> bool:
+    import debugpy  # noqa: T100
+
+    if not is_debugpy_installed():
+        return False
+
+    class T(threading.Thread):
+        daemon = True
+        def run(self):
+            time.sleep(timeout)
+            debugpy.wait_for_client.cancel()
+    T().start()
+    debugpy.wait_for_client()
+    if debugpy.is_client_connected():
+        return True
+
+    return False
+
+def enable_debugpy(port: int, address = None) -> bool:
+
+    import debugpy  # noqa: T100
+
+    if address is None:
+        address = "0.0.0.0"
+
+    debugpy.listen((address, port))

src/iop/cls/IOP/Utils.cls

@@ -61,7 +61,7 @@ ClassMethod DeleteComponentProxy(pClassname As %String = "") As %Status
 {
 	#dim tSC As %Status = $$$OK
 	#dim ex As %Exception.AbstractException
-	#dim tIsPEX As %Boolean = 0
+	#dim tIsIOP As %Boolean = 0
 	#dim tClass As %Dictionary.CompiledClass
 
 	Quit:(""=pClassname) $$$ERROR($$$EnsErrGeneral,"Remote class name must be specified.")
@@ -79,16 +79,16 @@ ClassMethod DeleteComponentProxy(pClassname As %String = "") As %Status
 				Set tSC = $$$ERROR($$$EnsErrGeneral,$$$FormatText("Proxy class for remote class '%1' could not be opened.",pClassname))
 				Quit
 			}
-			Set tIsPEX = ("IOP.Utils" = tClass.GeneratedBy)
+			Set tIsIOP = ("IOP.Utils" = tClass.GeneratedBy)
 		}
-		If tIsPEX {
+		If tIsIOP {
 			Set tSC = ##class(%Dictionary.ClassDefinition).%DeleteId(pClassname)
 			If $$$ISERR(tSC) {
 				Set tSC = $$$ERROR($$$EnsErrGeneral,$$$FormatText("Unable to delete proxy class for remote class '%1' : '%2'.",pClassname,$System.Status.GetErrorText(tSC)))
 				Quit
 			}
 		} Else {
-			Set tSC = $$$ERROR($$$EnsErrGeneral,$$$FormatText("Cannot delete class '%1' because it is not a PEX proxy class.",pClassname))
+			Set tSC = $$$ERROR($$$EnsErrGeneral,$$$FormatText("Cannot delete class '%1' because it is not a IOP proxy class.",pClassname))
 			Quit
 		}
 
@@ -179,23 +179,23 @@ ClassMethod GenerateProxyClass(
 				Set tSC = $$$ERROR($$$EnsErrGeneral,$$$FormatText("Proxy class '%1' already exists.",pClassname))
 				Quit
 			} Else {
-				#dim tIsPEX As %Boolean = 0
+				#dim tIsIOP As %Boolean = 0
 				If $classmethod(pClassname,"%Extends","IOP.Common") {
 					#dim tClass As %Dictionary.CompiledClass = ##class(%Dictionary.CompiledClass).%OpenId(pClassname)
 					If '$IsObject(tClass) {
 						Set tSC = $$$ERROR($$$EnsErrGeneral,"Class not found")
 						Quit
 					}
-					Set tIsPEX = ("IOP.Utils" = tClass.GeneratedBy)
+					Set tIsIOP = ("IOP.Utils" = tClass.GeneratedBy)
 				}
-				If tIsPEX {
+				If tIsIOP {
 					Set tSC = ##class(%Dictionary.ClassDefinition).%DeleteId(pClassname)
 					If $$$ISERR(tSC) {
 						Set tSC = $$$ERROR($$$EnsErrGeneral,$$$FormatText("Unable to delete existing proxy class '%1' : '%2'.",pClassname,$System.Status.GetErrorText(tSC)))
 						Quit
 					}
 				} Else {
-					Set tSC = $$$ERROR($$$EnsErrGeneral,$$$FormatText("Cannot overwrite class '%1' because it is not a PEX proxy class.",pClassname))
+					Set tSC = $$$ERROR($$$EnsErrGeneral,$$$FormatText("Cannot overwrite class '%1' because it is not a IOP proxy class.",pClassname))
 					Quit
 				}
 			}
@@ -208,7 +208,7 @@ ClassMethod GenerateProxyClass(
 
 		#dim tSuperClass As %String = pClassDetails."__getitem__"(0)
 		If (""=tSuperClass) {
-			Set tSC = $$$ERROR($$$EnsErrGeneral,"No PEX superclass found.")
+			Set tSC = $$$ERROR($$$EnsErrGeneral,"No IOP superclass found.")
 			Quit
 		}
 		If '$Case($P(tSuperClass,".",*),"DuplexProcess":1,"DuplexService":1,"DuplexOperation":1,"InboundAdapter":1,"OutboundAdapter":1,"BusinessService":1,"BusinessProcess":1,"BusinessOperation":1,:0) {
@@ -323,6 +323,56 @@ ClassMethod GenerateProxyClass(
 		}
 		Quit:$$$ISERR(tSC)
 
+		#; Add debug settings, three settings are always available debug a boolean, port an integer and a timeout an integer
+		Set tPropCat = "Python Debug"
+		#; Debug property
+		Set tPropDebug = ##class(%Dictionary.PropertyDefinition).%New()
+		Set tPropDebug.Name = "enable"
+		Set tPropDebug.Type = "%Boolean"
+		Set tPropDebug.InitialExpression = $$$quote(0)
+		Set tPropDebug.Description = "Enable or disable debug"
+		
+		Set tSC = tCOSClass.Properties.Insert(tPropDebug)
+		Quit:$$$ISERR(tSC)
+
+		#; Add the settings parameter
+		Set tSETTINGSParamValue = tSETTINGSParamValue_",enable:"_tPropCat
+
+		#; Port property
+		Set tPropPort = ##class(%Dictionary.PropertyDefinition).%New()
+		Set tPropPort.Name = "port"
+		Set tPropPort.Type = "%Integer"
+		Set tPropPort.InitialExpression = $$$quote(0)
+		Set tPropPort.Description = "Port to use for the debug connection, if 0 an random port will be used"
+		Set tSC = tCOSClass.Properties.Insert(tPropPort)
+		Quit:$$$ISERR(tSC)
+
+		#; Add the settings parameter
+		Set tSETTINGSParamValue = tSETTINGSParamValue_",port:"_tPropCat
+
+		#; Timeout property
+		Set tPropTimeout = ##class(%Dictionary.PropertyDefinition).%New()
+		Set tPropTimeout.Name = "timeout"
+		Set tPropTimeout.Type = "%Integer"
+		Set tPropTimeout.InitialExpression = $$$quote(30)
+		Set tSC = tCOSClass.Properties.Insert(tPropTimeout)
+		Quit:$$$ISERR(tSC)
+
+		#; Add the settings parameter
+		Set tSETTINGSParamValue = tSETTINGSParamValue_",timeout:"_tPropCat
+
+		#; PythonInterpreterPath property
+		Set tPropInterpre = ##class(%Dictionary.PropertyDefinition).%New()
+		Set tPropInterpre.Name = "PythonInterpreterPath"
+		Set tPropInterpre.Type = "%String"
+		Set tPropInterpre.Description = "Path to the Python interpreter, if not set the default one will be used"
+		Do tPropInterpre.Parameters.SetAt("255","MAXLEN")
+		Set tSC = tCOSClass.Properties.Insert(tPropInterpre)
+		Quit:$$$ISERR(tSC)
+
+		#; Add the settings parameter
+		Set tSETTINGSParamValue = tSETTINGSParamValue_",PythonInterpreterPath:"_tPropCat
+
 		#dim tSETTINGSParam As %Dictionary.ParameterDefinition = ##class(%Dictionary.ParameterDefinition).%New()
 		Set tSETTINGSParam.Name = "SETTINGS"
 		Set tSETTINGSParam.Default = tSETTINGSParamValue

src/tests/bench/bench_bo.py

@@ -1,8 +1,10 @@
 from iop import BusinessOperation
 
 class BenchIoPOperation(BusinessOperation):
+
+    def on_init(self):
+        self.log_info("BenchIoPOperation initialized")
+
     def on_message(self, request):
 
         return request
-
-        

src/tests/test_business_operation.py

@@ -44,6 +44,8 @@ def test_dispatch_methods(operation):
     # Test dispatch initialization
     operation.DISPATCH = [("MessageType1", "handle_type1")]
     mock_host = MagicMock()
+    mock_host.port=0
+    mock_host.enable=False
 
     operation._dispatch_on_init(mock_host)
 
@@ -63,7 +65,10 @@ def handle_simple(self, request: SimpleMessage):
     request.json = '{"integer": 1, "string": "test"}'
     request.classname = 'registerFilesIop.message.SimpleMessage'
     operation = CustomOperation()
-    operation._dispatch_on_init(MagicMock())
+    mock_host = MagicMock()
+    mock_host.port=0
+    mock_host.enable=False
+    operation._dispatch_on_init(mock_host)
     response = operation._dispatch_on_message(request)
     excepted_response = dispatch_serializer(SimpleMessage(integer=2, string='handled'))
 
@@ -75,7 +80,10 @@ def handle_simple(self, request: SimpleMessage):
             return SimpleMessage(integer=request.integer + 1, string="handled")
 
     operation = CustomOperation()
-    operation._dispatch_on_init(MagicMock())
+    mock_host = MagicMock()
+    mock_host.port=0
+    mock_host.enable=False
+    operation._dispatch_on_init(mock_host)
     operation.iris_handle = MagicMock()
 
     request = SimpleMessage(integer=1, string='test')

src/tests/test_business_process.py

@@ -68,6 +68,9 @@ def __init__(self):
 
 def test_dispatch_methods(process):
     mock_host = MagicMock()
+    mock_host.port=0
+    mock_host.enable=False
+
     request = SimpleMessage(integer=1, string='test')
     response = SimpleMessage(integer=2, string='response')