Flip logic and add some comments

Author: keelerm84

ldclient/impl/datasourcev2/streaming.py

@@ -143,7 +143,7 @@ def sync(self) -> Iterable[Update]:
                 if action.error is None:
                     continue
 
-                (should_continue, update) = self._handle_error(action.error)
+                (update, should_continue) = self._handle_error(action.error)
                 if update is not None:
                     yield update
 
@@ -165,7 +165,7 @@ def sync(self) -> Iterable[Update]:
                 # TODO(sdk-1409)
                 # self._sse.interrupt()
 
-                (should_continue, update) = self._handle_error(e)
+                (update, should_continue) = self._handle_error(e)
                 if update is not None:
                     yield update
                 if not should_continue:
@@ -294,8 +294,16 @@ def _process_message(
         log.info("Unexpected event found in stream: %s", msg.event)
         return None
 
-    # Returns true to continue, false to stop
-    def _handle_error(self, error: Exception) -> Tuple[bool, Optional[Update]]:
+    def _handle_error(self, error: Exception) -> Tuple[Optional[Update], bool]:
+        """
+        This method handles errors that occur during the streaming process.
+
+        It may return an update indicating the error state, and a boolean
+        indicating whether the synchronizer should continue retrying the connection.
+
+        If an update is provided, it should be forward upstream, regardless of
+        whether or not we are going to retry this failure.
+        """
         # if not self._running:
         #     return (False, None)  # don't retry if we've been deliberately stopped
 
@@ -312,7 +320,7 @@ def _handle_error(self, error: Exception) -> Tuple[bool, Optional[Update]]:
                 revert_to_fdv1=False,
                 environment_id=None,  # TODO(sdk-1410)
             )
-            return (True, update)
+            return (update, True)
 
         if isinstance(error, HTTPStatusError):
             error_info = DataSourceErrorInfo(
@@ -345,10 +353,10 @@ def _handle_error(self, error: Exception) -> Tuple[bool, Optional[Update]]:
                 # self._ready.set()  # if client is initializing, make it stop waiting; has no effect if already inited
                 # self.__stop_with_error_info(error_info)
                 # self.stop()
-                return (False, update)
+                return (update, False)
 
             log.warning(http_error_message_result)
-            return (True, update)
+            return (update, True)
 
         log.warning("Unexpected error on stream connection: %s, will retry", error)
 
@@ -363,7 +371,7 @@ def _handle_error(self, error: Exception) -> Tuple[bool, Optional[Update]]:
         # no stacktrace here because, for a typical connection error, it'll
         # just be a lengthy tour of urllib3 internals
 
-        return (True, update)
+        return (update, True)
 
     # magic methods for "with" statement (used in testing)
     def __enter__(self):