ValueError on invalid connection_acquisition_timeout (#1168)

 - `ValueError` on invalid values (instead of `ClientError`)
 - Consistently restrict the value to be strictly positive

Signed-off-by: Rouven Bauer <[email protected]>
Co-authored-by: Andy Heap <[email protected]>

Author: robsdedude

CHANGELOG.md

@@ -37,6 +37,9 @@ See also https://github.com/neo4j/neo4j-python-driver/wiki for a full changelog.
   - `neo4j.exceptions.UnsupportedServerProduct` if no common bolt protocol version could be negotiated with the server
    (instead of internal `neo4j._exceptions.BoltHandshakeError`).  
     `UnsupportedServerProduct` is now a subclass of `ServiceUnavailable` (instead of `Exception` directly).
+  - `connection_acquisition_timeout` configuration option
+    - `ValueError` on invalid values (instead of `ClientError`)
+    - Consistently restrict the value to be strictly positive
 
 
 ## Version 5.28

src/neo4j/_async/io/_pool.py

@@ -19,6 +19,7 @@
 import abc
 import asyncio
 import logging
+import math
 import typing as t
 from collections import (
     defaultdict,
@@ -670,6 +671,7 @@ async def acquire(
         # The access_mode and database is not needed for a direct connection,
         # it's just there for consistency.
         access_mode = check_access_mode(access_mode)
+        _check_acquisition_timeout(timeout)
         log.debug(
             "[#0000]  _: <POOL> acquire direct connection, "
             "access_mode=%r, database=%r",
@@ -972,6 +974,7 @@ async def update_routing_table(
 
         :raise neo4j.exceptions.ServiceUnavailable:
         """
+        _check_acquisition_timeout(acquisition_timeout)
         async with self.refresh_lock:
             routing_table = await self.get_routing_table(database)
             if routing_table is not None:
@@ -1149,11 +1152,7 @@ async def acquire(
         database_callback=None,
     ):
         access_mode = check_access_mode(access_mode)
-        if not timeout:
-            # TODO: 6.0 - change this to be a ValueError
-            raise ClientError(
-                f"'timeout' must be a float larger than 0; {timeout}"
-            )
+        _check_acquisition_timeout(timeout)
 
         target_database = database.name
 
@@ -1246,3 +1245,17 @@ async def on_write_failure(self, address, database):
             if table is not None:
                 table.writers.discard(address)
         log.debug("[#0000]  _: <POOL> table=%r", self.routing_tables)
+
+
+def _check_acquisition_timeout(timeout: object) -> None:
+    if not isinstance(timeout, (int, float)):
+        raise TypeError(
+            "Connection acquisition timeout must be a number, "
+            f"got {type(timeout)}"
+        )
+    if timeout <= 0:
+        raise ValueError(
+            f"Connection acquisition timeout must be > 0, got {timeout}"
+        )
+    if math.isnan(timeout):
+        raise ValueError("Connection acquisition timeout must not be NaN")

src/neo4j/_sync/io/_pool.py

@@ -981,9 +981,15 @@ async def forced_routing_table_update(backend, data):
     driver = backend.drivers[driver_id]
     database = data["database"]
     bookmarks = data["bookmarks"]
+    acquisition_timeout = (
+        driver._default_workspace_config.connection_acquisition_timeout
+    )
     async with driver._pool.refresh_lock:
         await driver._pool.update_routing_table(
-            database=database, imp_user=None, bookmarks=bookmarks
+            database=database,
+            imp_user=None,
+            bookmarks=bookmarks,
+            acquisition_timeout=acquisition_timeout,
         )
     await backend.send_response("Driver", {"id": driver_id})