PYTHON-4924 - PoolClearedError should have TransientTransactionError label appended to it

Author: NoahStapp

pymongo/asynchronous/pool.py

@@ -190,6 +190,10 @@ def _raise_connection_failure(
 ) -> NoReturn:
     """Convert a socket.error to ConnectionFailure and raise it."""
     host, port = address
+    if isinstance(error, PyMongoError) and error._error_labels:
+        labels = error._error_labels
+    else:
+        labels = None
     # If connecting to a Unix socket, port will be None.
     if port is not None:
         msg = "%s:%d: %s" % (host, port, error)
@@ -200,15 +204,15 @@ def _raise_connection_failure(
     if "configured timeouts" not in msg:
         msg += format_timeout_details(timeout_details)
     if isinstance(error, socket.timeout):
-        raise NetworkTimeout(msg) from error
+        raise NetworkTimeout(msg, errors={"errorLabels": labels}) from error
     elif isinstance(error, SSLError) and "timed out" in str(error):
         # Eventlet does not distinguish TLS network timeouts from other
         # SSLErrors (https://github.com/eventlet/eventlet/issues/692).
         # Luckily, we can work around this limitation because the phrase
         # 'timed out' appears in all the timeout related SSLErrors raised.
-        raise NetworkTimeout(msg) from error
+        raise NetworkTimeout(msg, errors={"errorLabels": labels}) from error
     else:
-        raise AutoReconnect(msg) from error
+        raise AutoReconnect(msg, errors={"errorLabels": labels}) from error
 
 
 def _get_timeout_details(options: PoolOptions) -> dict[str, float]:
@@ -1420,9 +1424,9 @@ def _raise_if_not_ready(self, checkout_started_time: float, emit_event: bool) ->
                     )
 
             details = _get_timeout_details(self.opts)
-            _raise_connection_failure(
-                self.address, AutoReconnect("connection pool paused"), timeout_details=details
-            )
+            error = AutoReconnect("connection pool paused")
+            error._add_error_label("TransientTransactionError")
+            _raise_connection_failure(self.address, error, timeout_details=details)
 
     async def _get_conn(
         self, checkout_started_time: float, handler: Optional[_MongoClientErrorHandler] = None

pymongo/synchronous/pool.py

@@ -190,6 +190,10 @@ def _raise_connection_failure(
 ) -> NoReturn:
     """Convert a socket.error to ConnectionFailure and raise it."""
     host, port = address
+    if isinstance(error, PyMongoError) and error._error_labels:
+        labels = error._error_labels
+    else:
+        labels = None
     # If connecting to a Unix socket, port will be None.
     if port is not None:
         msg = "%s:%d: %s" % (host, port, error)
@@ -200,15 +204,15 @@ def _raise_connection_failure(
     if "configured timeouts" not in msg:
         msg += format_timeout_details(timeout_details)
     if isinstance(error, socket.timeout):
-        raise NetworkTimeout(msg) from error
+        raise NetworkTimeout(msg, errors={"errorLabels": labels}) from error
     elif isinstance(error, SSLError) and "timed out" in str(error):
         # Eventlet does not distinguish TLS network timeouts from other
         # SSLErrors (https://github.com/eventlet/eventlet/issues/692).
         # Luckily, we can work around this limitation because the phrase
         # 'timed out' appears in all the timeout related SSLErrors raised.
-        raise NetworkTimeout(msg) from error
+        raise NetworkTimeout(msg, errors={"errorLabels": labels}) from error
     else:
-        raise AutoReconnect(msg) from error
+        raise AutoReconnect(msg, errors={"errorLabels": labels}) from error
 
 
 def _get_timeout_details(options: PoolOptions) -> dict[str, float]:
@@ -1414,9 +1418,9 @@ def _raise_if_not_ready(self, checkout_started_time: float, emit_event: bool) ->
                     )
 
             details = _get_timeout_details(self.opts)
-            _raise_connection_failure(
-                self.address, AutoReconnect("connection pool paused"), timeout_details=details
-            )
+            error = AutoReconnect("connection pool paused")
+            error._add_error_label("TransientTransactionError")
+            _raise_connection_failure(self.address, error, timeout_details=details)
 
     def _get_conn(
         self, checkout_started_time: float, handler: Optional[_MongoClientErrorHandler] = None

test/asynchronous/test_pooling.py

@@ -36,7 +36,7 @@
 from test.asynchronous.helpers import ConcurrentRunner
 from test.utils_shared import delay
 
-from pymongo.asynchronous.pool import Pool, PoolOptions
+from pymongo.asynchronous.pool import Pool, PoolOptions, PoolState
 from pymongo.socket_checker import SocketChecker
 
 _IS_SYNC = False
@@ -608,6 +608,21 @@ async def test_max_pool_size_with_connection_failure(self):
             # seems error-prone, so check the message too.
             self.assertNotIn("waiting for socket from pool", str(context.exception))
 
+    async def test_pool_cleared_error_labelled_transient(self):
+        test_pool = Pool(
+            ("localhost", 27017),
+            PoolOptions(max_pool_size=1),
+        )
+        # Pause the pool, causing it to fail connection checkout.
+        test_pool.state = PoolState.PAUSED
+
+        with self.assertRaises(AutoReconnect) as context:
+            async with test_pool.checkout():
+                pass
+
+        # Verify that the TransientTransactionError label is present in the error.
+        self.assertTrue(context.exception.has_error_label("TransientTransactionError"))
+
 
 if __name__ == "__main__":
     unittest.main()

test/test_pooling.py

@@ -37,7 +37,7 @@
 from test.utils_shared import delay
 
 from pymongo.socket_checker import SocketChecker
-from pymongo.synchronous.pool import Pool, PoolOptions
+from pymongo.synchronous.pool import Pool, PoolOptions, PoolState
 
 _IS_SYNC = True
 
@@ -606,6 +606,21 @@ def test_max_pool_size_with_connection_failure(self):
             # seems error-prone, so check the message too.
             self.assertNotIn("waiting for socket from pool", str(context.exception))
 
+    def test_pool_cleared_error_labelled_transient(self):
+        test_pool = Pool(
+            ("localhost", 27017),
+            PoolOptions(max_pool_size=1),
+        )
+        # Pause the pool, causing it to fail connection checkout.
+        test_pool.state = PoolState.PAUSED
+
+        with self.assertRaises(AutoReconnect) as context:
+            with test_pool.checkout():
+                pass
+
+        # Verify that the TransientTransactionError label is present in the error.
+        self.assertTrue(context.exception.has_error_label("TransientTransactionError"))
+
 
 if __name__ == "__main__":
     unittest.main()