Merge branch 'main' into loop_vs_keep_alive

# Conflicts:
#	adafruit_minimqtt/adafruit_minimqtt.py

Author: FoamyGuy

adafruit_minimqtt/adafruit_minimqtt.py

@@ -1034,6 +1034,13 @@ def loop(self, timeout: float = 0) -> Optional[list[int]]:
         :param float timeout: return after this timeout, in seconds.
 
         """
+        if timeout < self._socket_timeout:
+            raise MMQTTException(
+                # pylint: disable=consider-using-f-string
+                "loop timeout ({}) must be bigger ".format(timeout)
+                + "than socket timeout ({}))".format(self._socket_timeout)
+            )
+
         self._connected()
         self.logger.debug(f"waiting for messages for {timeout} seconds")
 
@@ -1065,11 +1072,13 @@ def loop(self, timeout: float = 0) -> Optional[list[int]]:
 
         return rcs if rcs else None
 
-    def _wait_for_msg(self) -> Optional[int]:
+    def _wait_for_msg(self, timeout: Optional[float] = None) -> Optional[int]:
         # pylint: disable = too-many-return-statements
 
         """Reads and processes network events.
         Return the packet type or None if there is nothing to be received.
+
+        :param float timeout: return after this timeout, in seconds.
         """
         # CPython socket module contains a timeout attribute
         if hasattr(self._socket_pool, "timeout"):
@@ -1079,7 +1088,7 @@ def _wait_for_msg(self) -> Optional[int]:
                 return None
         else:  # socketpool, esp32spi
             try:
-                res = self._sock_exact_recv(1)
+                res = self._sock_exact_recv(1, timeout=timeout)
             except OSError as error:
                 if error.errno in (errno.ETIMEDOUT, errno.EAGAIN):
                     # raised by a socket timeout if 0 bytes were present
@@ -1148,7 +1157,9 @@ def _decode_remaining_length(self) -> int:
                 return n
             sh += 7
 
-    def _sock_exact_recv(self, bufsize: int) -> bytearray:
+    def _sock_exact_recv(
+        self, bufsize: int, timeout: Optional[float] = None
+    ) -> bytearray:
         """Reads _exact_ number of bytes from the connected socket. Will only return
         bytearray with the exact number of bytes requested.
 
@@ -1159,6 +1170,7 @@ def _sock_exact_recv(self, bufsize: int) -> bytearray:
         bytes is returned or trigger a timeout exception.
 
         :param int bufsize: number of bytes to receive
+        :param float timeout: timeout, in seconds. Defaults to keep_alive
         :return: byte array
         """
         stamp = self.get_monotonic_time()
@@ -1170,7 +1182,7 @@ def _sock_exact_recv(self, bufsize: int) -> bytearray:
             to_read = bufsize - recv_len
             if to_read < 0:
                 raise MMQTTException(f"negative number of bytes to read: {to_read}")
-            read_timeout = self.keep_alive
+            read_timeout = timeout if timeout is not None else self.keep_alive
             mv = mv[recv_len:]
             while to_read > 0:
                 recv_len = self._sock.recv_into(mv, to_read)

tests/test_loop.py

@@ -108,9 +108,9 @@ class Loop(TestCase):
     INITIAL_RCS_VAL = 42
     rcs_val = INITIAL_RCS_VAL
 
-    def fake_wait_for_msg(self):
+    def fake_wait_for_msg(self, timeout=1):
         """_wait_for_msg() replacement. Sleeps for 1 second and returns an integer."""
-        time.sleep(1)
+        time.sleep(timeout)
         retval = self.rcs_val
         self.rcs_val += 1
         return retval
@@ -151,13 +151,33 @@ def test_loop_basic(self) -> None:
 
             # Check the return value.
             assert rcs is not None
-            assert len(rcs) > 1
+            assert len(rcs) >= 1
             expected_rc = self.INITIAL_RCS_VAL
             # pylint: disable=not-an-iterable
             for ret_code in rcs:
                 assert ret_code == expected_rc
                 expected_rc += 1
 
+    # pylint: disable=invalid-name
+    def test_loop_timeout_vs_socket_timeout(self):
+        """
+        loop() should throw MMQTTException if the timeout argument
+        is bigger than the socket timeout.
+        """
+        mqtt_client = MQTT.MQTT(
+            broker="127.0.0.1",
+            port=1883,
+            socket_pool=socket,
+            ssl_context=ssl.create_default_context(),
+            socket_timeout=1,
+        )
+
+        mqtt_client.is_connected = lambda: True
+        with self.assertRaises(MQTT.MMQTTException) as context:
+            mqtt_client.loop(timeout=0.5)
+
+        assert "loop timeout" in str(context.exception)
+
     def test_loop_is_connected(self):
         """
         loop() should throw MMQTTException if not connected