Add timeout options to call_service messages

Author: bjsowa

ROSBRIDGE_PROTOCOL.md

@@ -436,7 +436,8 @@ Calls a ROS service.
   "service": <string>,
   (optional) "args": <list<json>>,
   (optional) "fragment_size": <int>,
-  (optional) "compression": <string>
+  (optional) "compression": <string>,
+  (optional) "timeout": <float>
 }
 ```
 
@@ -449,6 +450,7 @@ Calls a ROS service.
     before it is fragmented
  * **compression** – an optional string to specify the compression scheme to be
     used on messages. Valid values are "none" and "png"
+ * **timeout** – the time, in seconds, to wait for a response from the server
 
 
 Stops advertising an external ROS service server

rosbridge_library/src/rosbridge_library/capabilities/call_service.py

@@ -81,6 +81,7 @@ def call_service(self, message):
         fragment_size = message.get("fragment_size", None)
         compression = message.get("compression", "none")
         args = message.get("args", [])
+        timeout = message.get("timeout", 5.0)
 
         if CallService.services_glob is not None and CallService.services_glob:
             self.protocol.log(
@@ -112,7 +113,14 @@ def call_service(self, message):
         e_cb = partial(self._failure, cid, service)
 
         # Run service caller in the same thread.
-        ServiceCaller(trim_servicename(service), args, s_cb, e_cb, self.protocol.node_handle).run()
+        ServiceCaller(
+            trim_servicename(service),
+            args,
+            timeout,
+            s_cb,
+            e_cb,
+            self.protocol.node_handle,
+        ).run()
 
     def _success(self, cid, service, fragment_size, compression, message):
         outgoing_message = {

rosbridge_library/src/rosbridge_library/internal/services.py

@@ -58,6 +58,7 @@ def __init__(
         self,
         service: str,
         args: dict,
+        timeout: float,
         success_callback: Callable[[str, str, int, bool, Any], None],
         error_callback: Callable[[str, str, Exception], None],
         node_handle: Node,
@@ -71,6 +72,7 @@ def __init__(
         ordered list, or a dict of name-value pairs.  Anything else will be
         treated as though no arguments were provided (which is still valid for
         some kinds of service)
+        timeout -- the time, in seconds, to wait for a response from the server
         success_callback -- a callback to call with the JSON result of the
         service call
         error_callback   -- a callback to call if an error occurs.  The
@@ -81,14 +83,22 @@ def __init__(
         self.daemon = True
         self.service = service
         self.args = args
+        self.timeout = timeout
         self.success = success_callback
         self.error = error_callback
         self.node_handle = node_handle
 
     def run(self) -> None:
         try:
             # Call the service and pass the result to the success handler
-            self.success(call_service(self.node_handle, self.service, args=self.args))
+            self.success(
+                call_service(
+                    self.node_handle,
+                    self.service,
+                    args=self.args,
+                    server_response_timeout=self.timeout,
+                )
+            )
         except Exception as e:
             # On error, just pass the exception to the error handler
             self.error(e)
@@ -114,7 +124,8 @@ def call_service(
     node_handle: Node,
     service: str,
     args: Optional[dict] = None,
-    server_timeout_time: float = 1.0,
+    server_ready_timeout: float = 1.0,
+    server_response_timeout: float = 5.0,
     sleep_time: float = 0.001,
 ) -> dict:
     # Given the service name, fetch the type and class of the service,
@@ -141,20 +152,29 @@ def call_service(
         service_class, service, callback_group=ReentrantCallbackGroup()
     )
 
-    if not client.wait_for_service(server_timeout_time):
+    if not client.wait_for_service(server_ready_timeout):
         node_handle.destroy_client(client)
         raise InvalidServiceException(service)
 
     future = client.call_async(inst)
-    while rclpy.ok() and not future.done():
+    start_time = time.monotonic()
+    while (
+        rclpy.ok() and not future.done() and time.monotonic() - start_time < server_response_timeout
+    ):
         time.sleep(sleep_time)
+
+    if not future.done():
+        future.cancel()
+        node_handle.destroy_client(client)
+        raise Exception("Timeout exceeded while waiting for service response")
+
     result = future.result()
 
     node_handle.destroy_client(client)
     if result is not None:
         # Turn the response into JSON and pass to the callback
         json_response = extract_values(result)
     else:
-        raise Exception(result)
+        raise Exception("Service call returned None")
 
     return json_response

rosbridge_library/test/internal/services/test_services.py

@@ -52,6 +52,7 @@ def start(self):
         thread = services.ServiceCaller(
             self.name,
             gen,
+            5.0,
             self.success,
             self.error,
             self.node,
@@ -201,6 +202,7 @@ def error():
         services.ServiceCaller(
             self.node.get_name() + "/list_parameters",
             None,
+            5.0,
             success,
             error,
             self.node,