Improve logs when receiving invalid messages

Author: unaiur

maxcube/cube.py

@@ -114,17 +114,20 @@ def room_by_id(self, id):
 
     def __parse_responses(self, messages):
         for msg in messages:
-            cmd = msg.cmd
-            if cmd == "C":
-                self.parse_c_message(msg.arg)
-            elif cmd == "H":
-                self.parse_h_message(msg.arg)
-            elif cmd == "L":
-                self.parse_l_message(msg.arg)
-            elif cmd == "M":
-                self.parse_m_message(msg.arg)
-            else:
-                logger.debug("Ignored unsupported message: %s" % (msg))
+            try:
+                cmd = msg.cmd
+                if cmd == "C":
+                    self.parse_c_message(msg.arg)
+                elif cmd == "H":
+                    self.parse_h_message(msg.arg)
+                elif cmd == "L":
+                    self.parse_l_message(msg.arg)
+                elif cmd == "M":
+                    self.parse_m_message(msg.arg)
+                else:
+                    logger.debug("Ignored unsupported message: %s" % (msg))
+            except Exception:
+                logger.warn(f"Error processing response message {msg}", exc_info=True)
 
     def parse_c_message(self, message):
         logger.debug("Parsing c_message: " + message)

maxcube/message.py

@@ -9,8 +9,11 @@ class Message:
     def reply_cmd(self) -> str:
         return self.cmd.upper()
 
+    def __str__(self) -> str:
+        return f"{self.cmd}:{self.arg}"
+
     def encode(self) -> bytes:
-        return ("%s:%s\r\n" % (self.cmd, self.arg)).encode("utf-8")
+        return (f"{self.cmd}:{self.arg}\r\n").encode("utf-8")
 
     @staticmethod
     def decode(line: bytes) -> "Message":

tests/test_cube.py

@@ -52,6 +52,8 @@ def to_messages(lines):
         b"H:JEQ0341267,015d2a,0113,00000000,0336f10a,4b,29,110203,172a,03,0000",
         b"M:00,01,VgICAQpCYWRlemltbWVyDi66AgpXb2huemltbWVyAAAAAwEOLrpLRVExMDg2NDM3ClRoZXJtb3N0YXQBAwoIgUtFUTA2NTU3NDMOV2"
         b"FuZHRoZXJtb3N0YXQCBAyisktFUTA4Mzk3NzgORmVuc3RlcmtvbnRha3QBAQ==",
+        b"M:INVALID_M_MESSAGE",
+        b"ZZ:INVALID_MESSAGE_TYPE",
         b"C:015d2a,7QFdKgATAf9KRVEwMzQxMjY3AQsABEAAAAAAAAAAAP///////////////////////////wsABEAAAAAAAAAAQf///////////////"
         b"////////////2h0dHA6Ly9tYXguZXEtMy5kZTo4MC9jdWJlADAvbG9va3VwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
         b"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAENFVAAACgADAAAOEENFU1QAAwACAAAcIA==",