Add tests for null, 0, and -1 tx timeout (#356)

Changes the protocol:
 * tx timeout in protocol is now an optional field

Author: robsdedude

nutkit/frontend/session.py

@@ -19,9 +19,9 @@ def close(self, hooks=None):
         if not isinstance(res, protocol.Session):
             raise Exception("Should be session but was: %s" % res)
 
-    def run(self, cypher, params=None, tx_meta=None, timeout=None, hooks=None):
+    def run(self, cypher, params=None, tx_meta=None, hooks=None, **kwargs):
         req = protocol.SessionRun(self._session.id, cypher, params,
-                                  txMeta=tx_meta, timeout=timeout)
+                                  txMeta=tx_meta, **kwargs)
         self._backend.send(req, hooks=hooks)
         while True:
             res = self._backend.receive(hooks=hooks)
@@ -91,23 +91,23 @@ def process_transaction(self, req, fn, config=None, hooks=None):
             elif isinstance(res, protocol.RetryableDone):
                 return x
 
-    def read_transaction(self, fn, tx_meta=None, timeout=None, hooks=None):
+    def read_transaction(self, fn, tx_meta=None, hooks=None, **kwargs):
         # Send request to enter transactional read function
         req = protocol.SessionReadTransaction(
-            self._session.id, txMeta=tx_meta, timeout=timeout
+            self._session.id, txMeta=tx_meta, **kwargs
         )
         return self.process_transaction(req, fn, hooks=hooks)
 
-    def write_transaction(self, fn, tx_meta=None, timeout=None, hooks=None):
+    def write_transaction(self, fn, tx_meta=None, hooks=None, **kwargs):
         # Send request to enter transactional read function
         req = protocol.SessionWriteTransaction(
-            self._session.id, txMeta=tx_meta, timeout=timeout
+            self._session.id, txMeta=tx_meta, **kwargs
         )
         return self.process_transaction(req, fn, hooks=hooks)
 
-    def begin_transaction(self, tx_meta=None, timeout=None, hooks=None):
+    def begin_transaction(self, tx_meta=None, hooks=None, **kwargs):
         req = protocol.SessionBeginTransaction(
-            self._session.id, txMeta=tx_meta, timeout=timeout
+            self._session.id, txMeta=tx_meta, **kwargs
         )
         res = self._backend.send_and_receive(req, hooks=hooks)
         if not isinstance(res, protocol.Transaction):

nutkit/protocol/requests.py

@@ -238,12 +238,13 @@ class SessionRun:
     Backend should respond with a Result response or an Error response.
     """
 
-    def __init__(self, sessionId, cypher, params, txMeta=None, timeout=None):
+    def __init__(self, sessionId, cypher, params, txMeta=None, **kwargs):
         self.sessionId = sessionId
         self.cypher = cypher
         self.params = params
         self.txMeta = txMeta
-        self.timeout = timeout
+        if "timeout" in kwargs:
+            self.timeout = kwargs["timeout"]
 
 
 class SessionReadTransaction:
@@ -253,10 +254,11 @@ class SessionReadTransaction:
     Backend should respond with a RetryableTry response or an Error response.
     """
 
-    def __init__(self, sessionId, txMeta=None, timeout=None):
+    def __init__(self, sessionId, txMeta=None, **kwargs):
         self.sessionId = sessionId
         self.txMeta = txMeta
-        self.timeout = timeout
+        if "timeout" in kwargs:
+            self.timeout = kwargs["timeout"]
 
 
 class SessionWriteTransaction:
@@ -266,10 +268,11 @@ class SessionWriteTransaction:
     Backend should respond with a RetryableTry response or an Error response.
     """
 
-    def __init__(self, sessionId, txMeta=None, timeout=None):
+    def __init__(self, sessionId, txMeta=None, **kwargs):
         self.sessionId = sessionId
         self.txMeta = txMeta
-        self.timeout = timeout
+        if "timeout" in kwargs:
+            self.timeout = kwargs["timeout"]
 
 
 class SessionBeginTransaction:
@@ -279,10 +282,11 @@ class SessionBeginTransaction:
     Backend should respond with a Transaction response or an Error response.
     """
 
-    def __init__(self, sessionId, txMeta=None, timeout=None):
+    def __init__(self, sessionId, txMeta=None, **kwargs):
         self.sessionId = sessionId
         self.txMeta = txMeta
-        self.timeout = timeout
+        if "timeout" in kwargs:
+            self.timeout = kwargs["timeout"]
 
 
 class SessionLastBookmarks:

tests/stub/session_run_parameters/scripts/timeout_-1.script

@@ -0,0 +1,14 @@
+!: BOLT 4.4
+
+A: HELLO {"{}": "*"}
+*: RESET
+# We expect the driver to not even try this. So should it do so nonetheless,
+# we will let is pass to not cause any error. The error should be generated
+# inside the driver.
+C: BEGIN {"[tx_timeout]": "*"}
+S: SUCCESS {"fields": ["n"]}
+C: PULL {"n": 1000}
+S: RECORD [1]
+   SUCCESS {"type": "w"}
+*: RESET
+?: GOODBYE

tests/stub/session_run_parameters/scripts/timeout_0.script

@@ -0,0 +1,11 @@
+!: BOLT 4.4
+
+A: HELLO {"{}": "*"}
+*: RESET
+C: RUN "RETURN 1 as n" {} {"tx_timeout": 0}
+S: SUCCESS {"fields": ["n"]}
+C: PULL {"n": 1000}
+S: RECORD [1]
+   SUCCESS {"type": "w"}
+*: RESET
+?: GOODBYE

tests/stub/session_run_parameters/scripts/timeout.script renamed to tests/stub/session_run_parameters/scripts/timeout_17.script

@@ -0,0 +1,11 @@
+!: BOLT 4.4
+
+A: HELLO {"{}": "*"}
+*: RESET
+C: RUN "RETURN 1 as n" {} {"[tx_timeout]": null}
+S: SUCCESS {"fields": ["n"]}
+C: PULL {"n": 1000}
+S: RECORD [1]
+   SUCCESS {"type": "w"}
+*: RESET
+?: GOODBYE

tests/stub/session_run_parameters/scripts/timeout_homedb.script renamed to tests/stub/session_run_parameters/scripts/timeout_17_homedb.script

@@ -122,9 +122,29 @@ def test_tx_meta(self):
     def test_timeout(self):
         for routing in (True, False):
             with self.subTest("routing" if routing else "direct"):
-                self._run("timeout", routing,
+                self._run("timeout_17", routing,
                           session_args=("w",), run_kwargs={"timeout": 17})
 
+    @driver_feature(types.Feature.BOLT_4_4)
+    def test_0_timeout(self):
+        self._run("timeout_0", routing=False,
+                  session_args=("w",), run_kwargs={"timeout": 0})
+
+    @driver_feature(types.Feature.BOLT_4_4)
+    def test_null_timeout(self):
+        self._run("timeout_null", routing=False,
+                  session_args=("w",), run_kwargs={"timeout": None})
+
+    @driver_feature(types.Feature.BOLT_4_4)
+    def test_default_timeout(self):
+        self._run("timeout_null", routing=False, session_args=("w",))
+
+    @driver_feature(types.Feature.BOLT_4_4)
+    def test_negative_timeout(self):
+        with self.assertRaises(types.DriverError):
+            self._run("timeout_-1", routing=False,
+                      session_args=("w",), run_kwargs={"timeout": -1})
+
     @driver_feature(types.Feature.IMPERSONATION,
                     types.Feature.BOLT_4_4)
     def test_database(self):

tests/stub/session_run_parameters/scripts/timeout_null.script

@@ -0,0 +1,17 @@
+!: BOLT 4.4
+
+A: HELLO {"{}": "*"}
+*: RESET
+# We expect the driver to not even try this. So should it do so nonetheless,
+# we will let is pass to not cause any error. The error should be generated
+# inside the driver.
+C: BEGIN {"[tx_timeout]": "*"}
+S: SUCCESS {}
+C: RUN "RETURN 1 as n" {} {}
+S: SUCCESS {"fields": ["n"]}
+C: PULL {"n": 1000}
+S: SUCCESS {"type": "r"}
+C: COMMIT
+S: SUCCESS {}
+*: RESET
+?: GOODBYE

tests/stub/session_run_parameters/test_session_run_parameters.py

@@ -0,0 +1,14 @@
+!: BOLT 4.4
+
+A: HELLO {"{}": "*"}
+*: RESET
+C: BEGIN {"tx_timeout": 0}
+S: SUCCESS {}
+C: RUN "RETURN 1 as n" {} {}
+S: SUCCESS {"fields": ["n"]}
+C: PULL {"n": 1000}
+S: SUCCESS {"type": "r"}
+C: COMMIT
+S: SUCCESS {}
+*: RESET
+?: GOODBYE