Enhance logging descriptions in request methods to include component class name and target name; update documentation for message handling in BusinessProcess

Author: grongierisc

CHANGELOG.md

@@ -22,6 +22,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Strengthen application skills with a complete ingestion-pipeline architecture,
   container-backed runtime verification, non-blocking start and log commands,
   and IoP CLI-first operational checks.
+- Default description values for `send_request_sync()`, `send_request_async()`,
+  `send_request_async_ng()`, and `send_generator_request()` to include the
+  calling component class name and target name.
 
 ### Fixed
 - Prevent concurrent `send_request_async_ng()` calls from livelocking when

src/iop/components/business_host.py

@@ -84,8 +84,8 @@ def _resolve_attribute_target(host: Any, node: ast.Attribute) -> Any:
             return _UNRESOLVED
         value = getattr(value, attr, _UNRESOLVED)
     return value
-
-
+
+
 class _BusinessHost(_Common):
     """Base class for business components that defines common methods.
 
@@ -95,12 +95,12 @@ class _BusinessHost(_Common):
     as self.Output instead of hard-coded component names. See
     docs/cookbooks/production-settings-and-targets.md.
     """
-
-    buffer: int = 64000
-    DISPATCH: list[tuple[str, str]] = []
-
-    @input_serializer_param(1, "request")
-    @output_deserializer
+
+    buffer: int = 64000
+    DISPATCH: list[tuple[str, str]] = []
+
+    @input_serializer_param(1, "request")
+    @output_deserializer
     def send_request_sync(
         self,
         target: str | TargetSettingRef,
@@ -134,11 +134,13 @@ def send_request_sync(
             docs/cookbooks/production-settings-and-targets.md
         """
         target = resolve_target(target)
+        if description is None:
+            description = f"{self.__class__.__name__} -> {target}"
         return self.iris_handle.dispatchSendRequestSync(
             target, request, timeout, description
         )
-
-    @input_serializer_param(1, "request")
+
+    @input_serializer_param(1, "request")
     def send_request_async(
         self,
         target: str | TargetSettingRef,
@@ -170,6 +172,8 @@ def send_request_async(
             docs/cookbooks/production-settings-and-targets.md
         """
         target = resolve_target(target)
+        if description is None:
+            description = f"{self.__class__.__name__} -> {target}"
         return self.iris_handle.dispatchSendRequestAsync(target, request, description)
 
     async def send_request_async_ng(
@@ -186,14 +190,16 @@ async def send_request_async_ng(
 
         Args:
             target: Name of target component
-            request: Message to send
-            timeout: Timeout in seconds, -1 means wait forever
-            description: Optional description for logging
-
+            request: Message to send
+            timeout: Timeout in seconds, -1 means wait forever
+            description: Optional description for logging
+
         Returns:
             Response from target component
         """
         target = cast(str, resolve_target(target))
+        if description is None:
+            description = f"{self.__class__.__name__} -> {target}"
         return await AsyncRequest(target, request, timeout, description, self)
 
     def send_generator_request(
@@ -211,14 +217,16 @@ def send_generator_request(
         Args:
             target: Name of target component
             request: Message to send
-            timeout: Timeout in seconds, -1 means wait forever
-            description: Optional description for logging
-        Returns:
-            _GeneratorRequest: An instance of _GeneratorRequest to iterate over responses
+            timeout: Timeout in seconds, -1 means wait forever
+            description: Optional description for logging
+        Returns:
+            _GeneratorRequest: An instance of _GeneratorRequest to iterate over responses
         Raises:
             TypeError: If request is not of type Message
         """
         target = cast(str, resolve_target(target))
+        if description is None:
+            description = f"{self.__class__.__name__} -> {target}"
         return _GeneratorRequest(self, target, request, timeout, description)
 
     def send_multi_request_sync(
@@ -235,13 +243,13 @@ def send_multi_request_sync(
 
         Args:
             target_request: List of tuples (target, request) to send
-            timeout: Timeout in seconds, -1 means wait forever
-            description: Optional description for logging
-
-        Returns:
-            List of tuples (target, request, response, status)
-
-        Raises:
+            timeout: Timeout in seconds, -1 means wait forever
+            description: Optional description for logging
+
+        Returns:
+            List of tuples (target, request, response, status)
+
+        Raises:
             TypeError: If target_request is not a list of tuples
             ValueError: If target_request is empty
         """
@@ -254,11 +262,11 @@ def send_multi_request_sync(
             self._create_call_structure(target, request)
             for target, request in resolved_target_request
         ]
-
-        response_list = self.iris_handle.dispatchSendRequestSyncMultiple(
-            call_list, timeout
-        )
-
+
+        response_list = self.iris_handle.dispatchSendRequestSyncMultiple(
+            call_list, timeout
+        )
+
         return [
             (
                 resolved_target_request[i][0],
@@ -268,20 +276,20 @@ def send_multi_request_sync(
             )
             for i in range(len(resolved_target_request))
         ]
-
+
     def _validate_target_request(
         self, target_request: list[tuple[str | TargetSettingRef, Message | Any]]
     ) -> None:
-        """Validate the target_request parameter structure."""
-        if not isinstance(target_request, list):
-            raise TypeError("target_request must be a list")
-        if not target_request:
-            raise ValueError("target_request must not be empty")
-        if not all(
-            isinstance(item, tuple) and len(item) == 2 for item in target_request
-        ):
-            raise TypeError("target_request must contain tuples of (target, request)")
-
+        """Validate the target_request parameter structure."""
+        if not isinstance(target_request, list):
+            raise TypeError("target_request must be a list")
+        if not target_request:
+            raise ValueError("target_request must not be empty")
+        if not all(
+            isinstance(item, tuple) and len(item) == 2 for item in target_request
+        ):
+            raise TypeError("target_request must contain tuples of (target, request)")
+
     def _create_call_structure(
         self, target: str | TargetSettingRef, request: Message | Any
     ) -> Any:
@@ -291,34 +299,34 @@ def _create_call_structure(
         call.TargetDispatchName = resolve_target(target)
         call.Request = dispatch_serializer(request)
         return call
-
-    @staticmethod
-    def OnGetConnections() -> list[str] | None:
+
+    @staticmethod
+    def OnGetConnections() -> list[str] | None:
         """Return all configured targets for this class.
 
         Implement this method to allow connections between components to show up
         in the interoperability UI.
-
-        Returns:
-            An IRISList containing all targets for this class. Default is None.
-        """
-        return None
-
+
+        Returns:
+            An IRISList containing all targets for this class. Default is None.
+        """
+        return None
+
     @staticmethod
     def get_adapter_type() -> str | None:
-        """Returns the name of the registered Adapter.
-
-        Returns:
-            Name of the registered Adapter
-        """
-        return
-
+        """Returns the name of the registered Adapter.
+
+        Returns:
+            Name of the registered Adapter
+        """
+        return
+
     def on_get_connections(self) -> list[str]:
         """Return targets found in send_request_sync and send_request_async calls.
 
         Implement this method to allow connections between components to show up
         in the interoperability UI.
-
+
         Returns:
             A list containing all targets for this class.
         """
@@ -341,23 +349,23 @@ def on_get_connections(self) -> list[str]:
                 target_list.append(target)
 
         return target_list
-
-    @input_deserializer
-    def _dispatch_generator_started(self, request: Any) -> Any:
-        """For internal use only."""
+
+    @input_deserializer
+    def _dispatch_generator_started(self, request: Any) -> Any:
+        """For internal use only."""
         self._gen = dispatch_message(self, request)
-        # check if self._gen is a generator
-        if not hasattr(self._gen, "__iter__"):
-            raise TypeError(
-                f"Expected a generator or iterable object, got: {type(self._gen).__name__}"
-            )
-
-        return _iris.get_iris().IOP.Generator.Message.Ack._New()
-
-    @output_serializer
-    def _dispatch_generator_poll(self) -> Any:
-        """For internal use only."""
-        try:
-            return next(self._gen)
-        except StopIteration:
-            return _iris.get_iris().IOP.Generator.Message.Stop._New()
+        # check if self._gen is a generator
+        if not hasattr(self._gen, "__iter__"):
+            raise TypeError(
+                f"Expected a generator or iterable object, got: {type(self._gen).__name__}"
+            )
+
+        return _iris.get_iris().IOP.Generator.Message.Ack._New()
+
+    @output_serializer
+    def _dispatch_generator_poll(self) -> Any:
+        """For internal use only."""
+        try:
+            return next(self._gen)
+        except StopIteration:
+            return _iris.get_iris().IOP.Generator.Message.Stop._New()