refactor(azure-iot-device): ReconnectStage -> ConnectionStateStage (#1012)

* Renamed ReconnectStage to ConnectionStateStage
* Reduced footprint of the connection retry conditional
* Updated tests to account for new approach to connection retry conditional
* Updated logging

Author: cartertinney

azure-iot-device/azure/iot/device/common/pipeline/pipeline_stages_base.py

@@ -94,18 +94,14 @@ def __init__(self, pipeline_configuration):
             #
             .append_stage(pipeline_stages_base.AutoConnectStage())
             #
-            # ReconnectStage needs to be after AutoConnectStage because ReconnectStage sets/clears
-            # the virtually_connected flag and we want an automatic connection op to set this flag so
-            # we can reconnect auto-connect operations.  This is important, for example, if a
-            # send_message causes the transport to automatically connect, but that connection fails.
-            # When that happens, the ReconnectState will hold onto the ConnectOperation until it
-            # succeeds, and only then will return success to the AutoConnectStage which will
-            # allow the publish to continue.
+            # ConnectionStateStage needs to be after AutoConnectStage because the AutoConnectStage
+            # can create ConnectOperations and we (may) want to queue connection related operations
+            # in the ConnectionStateStage
             #
-            .append_stage(pipeline_stages_base.ReconnectStage())
+            .append_stage(pipeline_stages_base.ConnectionStateStage())
             #
-            # ConnectionLockStage needs to be after ReconnectStage because we want any ops that
-            # ReconnectStage creates to go through the ConnectionLockStage gate
+            # ConnectionLockStage needs to be after ConnectionStateStage because we want any ops that
+            # ConnectionStateStage creates to go through the ConnectionLockStage gate
             #
             .append_stage(pipeline_stages_base.ConnectionLockStage())
             #

azure-iot-device/azure/iot/device/iothub/pipeline/mqtt_pipeline.py

@@ -81,14 +81,14 @@ def __init__(self, pipeline_configuration):
             #
             .append_stage(pipeline_stages_base.AutoConnectStage())
             #
-            # ReconnectStage needs to be after AutoConnectStage because ReconnectStage sets/clears
-            # the virtually_conencted flag and we want an automatic connection op to set this flag so
-            # we can reconnect autoconnect operations.
+            # ConnectionStateStage needs to be after AutoConnectStage because the AutoConnectStage
+            # can create ConnectOperations and we (may) want to queue connection related operations
+            # in the ConnectionStateStage
             #
-            .append_stage(pipeline_stages_base.ReconnectStage())
+            .append_stage(pipeline_stages_base.ConnectionStateStage())
             #
-            # ConnectionLockStage needs to be after ReconnectStage because we want any ops that
-            # ReconnectStage creates to go through the ConnectionLockStage gate
+            # ConnectionLockStage needs to be after ConnectionStateStage because we want any ops that
+            # ConnectionStateStage creates to go through the ConnectionLockStage gate
             #
             .append_stage(pipeline_stages_base.ConnectionLockStage())
             #