improve error structure

Author: xiazhvera

AWSIoTPythonSDK/core/protocol/mqtt_core.py

@@ -28,8 +28,7 @@
 from AWSIoTPythonSDK.core.protocol.internal.defaults import METRICS_PREFIX
 from AWSIoTPythonSDK.core.protocol.internal.defaults import ALPN_PROTCOLS
 from AWSIoTPythonSDK.core.protocol.internal.events import FixedEventMids
-from AWSIoTPythonSDK.core.protocol.paho.client import MQTT_ERR_SUCCESS
-from AWSIoTPythonSDK.core.protocol.paho.client import MQTT_ERR_SUBACK_ERROR
+from AWSIoTPythonSDK.core.protocol.paho.client import MQTT_ERR_SUCCESS, SUBACK_ERROR
 from AWSIoTPythonSDK.exception.AWSIoTExceptions import connectError
 from AWSIoTPythonSDK.exception.AWSIoTExceptions import connectTimeoutException
 from AWSIoTPythonSDK.exception.AWSIoTExceptions import disconnectError
@@ -42,7 +41,7 @@
 from AWSIoTPythonSDK.exception.AWSIoTExceptions import subscribeQueueDisabledException
 from AWSIoTPythonSDK.exception.AWSIoTExceptions import unsubscribeQueueFullException
 from AWSIoTPythonSDK.exception.AWSIoTExceptions import unsubscribeQueueDisabledException
-from AWSIoTPythonSDK.exception.AWSIoTExceptions import subscribeError
+from AWSIoTPythonSDK.exception.AWSIoTExceptions import subscribeError, subackError
 from AWSIoTPythonSDK.exception.AWSIoTExceptions import subscribeTimeoutException
 from AWSIoTPythonSDK.exception.AWSIoTExceptions import unsubscribeError
 from AWSIoTPythonSDK.exception.AWSIoTExceptions import unsubscribeTimeoutException
@@ -311,9 +310,9 @@ def subscribe(self, topic, qos, message_callback=None):
                 self._internal_async_client.remove_event_callback(mid)
                 self._logger.error("Subscribe timed out")
                 raise subscribeTimeoutException()
-            if suback.data and suback.data[0] == MQTT_ERR_SUBACK_ERROR:
-                self._logger.error(f"Subscribe error: {suback.data}")
-                raise subscribeError(suback.data)
+            if suback.data and suback.data[0] == SUBACK_ERROR:
+                self._logger.error(f"Suback error return code: {suback.data[0]}")
+                raise subackError(suback=suback.data)
             ret = True
         return ret
 

AWSIoTPythonSDK/core/protocol/paho/client.py

@@ -97,6 +97,9 @@
 CONNACK_REFUSED_BAD_USERNAME_PASSWORD = 4
 CONNACK_REFUSED_NOT_AUTHORIZED = 5
 
+# SUBACK codes
+SUBACK_ERROR = 0x80
+
 # Connection state
 mqtt_cs_new = 0
 mqtt_cs_connected = 1
@@ -137,8 +140,6 @@
 MSG_QUEUEING_DROP_OLDEST = 0
 MSG_QUEUEING_DROP_NEWEST = 1
 
-# Packet Error Codes
-MQTT_ERR_SUBACK_ERROR = 0x80
 
 if sys.version_info[0] < 3:
     sockpair_data = "0"

AWSIoTPythonSDK/exception/AWSIoTExceptions.py

@@ -79,6 +79,11 @@ class subscribeError(operationError.operationError):
     def __init__(self, errorCode):
         self.message = "Subscribe Error: " + str(errorCode)
 
+class subackError(operationError.operationError):
+    def __init__(self, suback=None):
+        self.message = "Received Error suback. Subscription failed."
+        self.suback = suback
+
 
 class subscribeQueueFullException(operationError.operationError):
     def __init__(self):