Add Bolt 5.7: GQL-compliant errors

boltstub/__main__.py

@@ -146,8 +146,8 @@ def signal_handler(sig, frame):
         elif sigint_count == 2:
             print("2nd SIGINT received. Closing all connections.")
             service.close_all_connections_async()
-        if sigint_count > 3:
-            print("3nd SIGINT received. Hard exit.")
+        elif sigint_count >= 3:
+            print("3rd SIGINT received. Hard exit.")
             return exit_(130)
 
     if platform.system() == "Windows":

boltstub/bolt_protocol.py

@@ -561,3 +561,12 @@ class Bolt5x6Protocol(Bolt5x5Protocol):
     equivalent_versions = set()
 
     server_agent = "Neo4j/5.23.0"
+
+
+class Bolt5x7Protocol(Bolt5x6Protocol):
+    protocol_version = (5, 7)
+    version_aliases = set()
+    # allow the server to negotiate other bolt versions
+    equivalent_versions = set()
+
+    server_agent = "Neo4j/5.24.0"

nutkit/protocol/cypher.py

@@ -496,4 +496,18 @@ def as_cypher_type(value):
         return CypherString(value)
     if isinstance(value, (bytes, bytearray)):
         return CypherBytes(value)
+    if isinstance(
+        value,
+        (
+            CypherNode,
+            CypherRelationship,
+            CypherPath,
+            CypherPoint,
+            CypherDate,
+            CypherTime,
+            CypherDateTime,
+            CypherDuration,
+        )
+    ):
+        return value
     raise TypeError("Unsupported type: {}".format(type(value)))

nutkit/protocol/feature.py

@@ -123,6 +123,8 @@ class Feature(Enum):
     BOLT_5_5 = "Feature:Bolt:5.5"
     # The driver supports Bolt protocol version 5.6
     BOLT_5_6 = "Feature:Bolt:5.6"
+    # The driver supports Bolt protocol version 5.7
+    BOLT_5_7 = "Feature:Bolt:5.7"
     # The driver supports patching DateTimes to use UTC for Bolt 4.3 and 4.4
     BOLT_PATCH_UTC = "Feature:Bolt:Patch:UTC"
     # The driver supports impersonation

nutkit/protocol/responses.py

@@ -761,20 +761,81 @@ class DriverError(BaseError):
     """
 
     def __init__(self, id=None, errorType=None, msg="", code="",
-                 retryable=None):
+                 retryable=None, gqlStatus=None, statusDescription=None,
+                 cause=None, diagnosticRecord=None, classification=None,
+                 rawClassification=None):
         self.id = id
         self.errorType = errorType
         self.msg = msg
         self.code = code
         self.retryable = retryable
+        assert isinstance(gqlStatus, (str, type(None)))
+        self.gql_status = gqlStatus
+        assert isinstance(statusDescription, (str, type(None)))
+        self.status_description = statusDescription
+        if cause is not None:
+            assert isinstance(cause, GqlError)
+        self.cause = cause
+        assert isinstance(diagnosticRecord, (dict, type(None)))
+        self.diagnostic_record = diagnosticRecord
+        assert isinstance(classification, (str, type(None)))
+        self.classification = classification
+        assert isinstance(rawClassification, (str, type(None)))
+        self.raw_classification = rawClassification
 
     def __str__(self):
-        return f"DriverError(type={self.errorType}, msg={self.msg!r})"
+        return (
+            f"DriverError("
+            f"errorType={self.errorType!r}, "
+            f"msg={self.msg!r}, "
+            f"code={self.code!r}, "
+            f"retryable={self.retryable!r}, "
+            f"gqlStatus={self.gql_status!r}, "
+            f"statusDescription={self.status_description!r}, "
+            f"diagnosticRecord={self.diagnostic_record!r}, "
+            f"classification={self.classification!r}, "
+            f"rawClassification={self.raw_classification!r}, "
+            f"cause={self.cause!r})"
+        )
 
     def __repr__(self):
         return self.__str__()
 
 
+class GqlError:
+    """TODO."""
+
+    def __init__(self, msg="", gqlStatus=None, statusDescription=None,
+                 cause=None, diagnosticRecord=None, classification=None,
+                 rawClassification=None):
+        self.msg = msg
+        assert isinstance(gqlStatus, (str, type(None)))
+        self.gql_status = gqlStatus
+        assert isinstance(statusDescription, (str, type(None)))
+        self.status_description = statusDescription
+        if cause is not None:
+            assert isinstance(cause, GqlError)
+        self.cause = cause
+        assert isinstance(diagnosticRecord, (dict, type(None)))
+        self.diagnostic_record = diagnosticRecord
+        assert isinstance(classification, (str, type(None)))
+        self.classification = classification
+        assert isinstance(rawClassification, (str, type(None)))
+        self.raw_classification = rawClassification
+
+    def __str__(self):
+        return (
+            f"DriverErrorCause("
+            f"msg={self.msg!r}, "
+            f"gqlStatus={self.gql_status!r}, "
+            f"statusDescription={self.status_description!r}, "
+            f"diagnosticRecord={self.diagnostic_record!r}, "
+            f"classification={self.classification!r}, "
+            f"rawClassification={self.raw_classification!r}, "
+            f"cause={self.cause!r})"
+        )
+
+
 class FrontendError(BaseError):
     """
     Error originating from client code.

tests/stub/errors/scripts/error.script

@@ -0,0 +1,19 @@
+!: BOLT #BOLT_VERSION#
+
+A: HELLO {"{}": "*"}
+A: LOGON {"{}": "*"}
+*: RESET
+C: RUN {"U": "*"} {"{}": "*"} {"{}": "*"}
+S: FAILURE #ERROR#
+# Allow driver to pipeline a PULL or DISCARD after RUN
+{?
+    {{
+        C: PULL {"[n]": {"Z": "*"}}
+        S: IGNORED
+    ----
+        C: DISCARD {"[n]": {"Z": "*"}}
+        S: IGNORED
+    }}
+?}
++: RESET
+A: GOODBYE