Added 4.2 support

technige · technige · commit 8f708fe9374f · 2020-10-07T19:05:49.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,15 @@
 # Neo4j Driver Change Log
 
+## Version 4.2
+
+- No driver changes have been made for Neo4j 4.2
+
+
+## Version 4.1
+
+- Routing context is now forwarded to the server for when required by server-side routing
+
+
 ## Version 4.0 - Breaking Changes
 
 - The package version has jumped from `1.7` directly to `4.0`, in order to bring the version in line with Neo4j itself.
diff --git a/README.rst b/README.rst
@@ -75,10 +75,10 @@ See, https://neo4j.com/docs/migration-guide/4.0/upgrade-driver/#upgrade-driver-b
 See, https://neo4j.com/docs/driver-manual/current/client-applications/#driver-connection-uris for changes in default security settings between 3.x and 4.x
 
 
-Connecting with Python Driver 4.1 against Neo4j 3.5
----------------------------------------------------
+Connecting with Python Driver 4.x to Neo4j 3.5
+----------------------------------------------
 
-Using the Python Driver 4.1 and connecting to Neo4j 3.5 with default connection settings for Neo4j 3.5.
+Using the Python Driver 4.x and connecting to Neo4j 3.5 with default connection settings for Neo4j 3.5.
 
 .. code-block:: python
 
@@ -91,10 +91,10 @@ Using the Python Driver 4.1 and connecting to Neo4j 3.5 with default connection
     driver = GraphDatabase.driver("neo4j://localhost:7687", auth=("neo4j", "password"), encrypted=True, trust=False)
 
 
-Connecting with Python Driver 1.7 against Neo4j 4.1
----------------------------------------------------
+Connecting with Python Driver 1.7 to Neo4j 4.x
+----------------------------------------------
 
-Using the Python Driver 1.7 and connecting to Neo4j 4.1 with default connection settings for Neo4j 4.1.
+Using the Python Driver 1.7 and connecting to Neo4j 4.x with default connection settings for Neo4j 4.x.
 
 .. code-block:: python
 
diff --git a/neo4j/io/_bolt3.py b/neo4j/io/_bolt3.py
@@ -65,7 +65,7 @@
 class Bolt3(Bolt):
     """ Protocol handler for Bolt 3.
 
-    This is supported by Neo4j versions 3.5, 4.0 and 4.1.
+    This is supported by Neo4j versions 3.5, 4.0, 4.1 and 4.2.
     """
 
     PROTOCOL_VERSION = Version(3, 0)
diff --git a/neo4j/io/_bolt4.py b/neo4j/io/_bolt4.py
@@ -65,7 +65,7 @@
 class Bolt4x0(Bolt):
     """ Protocol handler for Bolt 4.0.
 
-    This is supported by Neo4j versions 4.0 and 4.1.
+    This is supported by Neo4j versions 4.0, 4.1 and 4.2.
     """
 
     PROTOCOL_VERSION = Version(4, 0)
@@ -370,7 +370,8 @@ def fetch_message(self):
                     self.pool.on_write_failure(address=self.unresolved_address),
                 raise
         else:
-            raise BoltProtocolError("Unexpected response message with signature %02X" % summary_signature, self.unresolved_address)
+            raise BoltProtocolError("Unexpected response message with signature "
+                                    "%02X" % ord(summary_signature), self.unresolved_address)
 
         return len(details), 1
 
@@ -459,7 +460,7 @@ def defunct(self):
 class Bolt4x1(Bolt4x0):
     """ Protocol handler for Bolt 4.1.
 
-    This is supported by Neo4j version 4.1.
+    This is supported by Neo4j versions 4.1 and 4.2.
     """
 
     PROTOCOL_VERSION = Version(4, 1)
@@ -474,3 +475,12 @@ def get_base_headers(self):
             "user_agent": self.user_agent,
             "routing": self.routing_context,
         }
+
+
+class Bolt4x2(Bolt4x1):
+    """ Protocol handler for Bolt 4.2.
+
+    This is supported by Neo4j version 4.2.
+    """
+
+    PROTOCOL_VERSION = Version(4, 2)
diff --git a/neo4j/meta.py b/neo4j/meta.py
@@ -21,7 +21,7 @@
 
 # Can be automatically overridden in builds
 package = "neo4j"
-version = "4.1.dev0"
+version = "4.2.dev0"
 
 
 def get_user_agent():
diff --git a/tests/stub/scripts/v4x2/empty_explicit_hello_goodbye.script b/tests/stub/scripts/v4x2/empty_explicit_hello_goodbye.script
@@ -0,0 +1,7 @@
+!: BOLT 4.2
+!: PORT 9001
+
+C: HELLO {"user_agent": "test", "scheme": "basic", "principal": "test", "credentials": "test", "routing": {"address": "localhost:9001"}}
+S: SUCCESS {"server": "Neo4j/4.2.0", "connection_id": "123e4567-e89b-12d3-a456-426655440000"}
+C: GOODBYE
+S: <EXIT>
diff --git a/tests/stub/scripts/v4x2/hello_with_routing_context_return_1_port_9002.script b/tests/stub/scripts/v4x2/hello_with_routing_context_return_1_port_9002.script
@@ -0,0 +1,12 @@
+!: BOLT 4.2
+!: AUTO GOODBYE
+!: AUTO RESET
+!: PORT 9002
+
+C: HELLO {"scheme": "basic", "principal": "test", "credentials": "test", "user_agent": "test", "routing": {"address": "localhost:9001", "policy": "my_policy", "region": "china"}}
+S: SUCCESS {"server": "Neo4j/4.2.0", "connection_id": "bolt-123456789"}
+C: RUN "RETURN 1 AS x" {} {"mode": "r"}
+   PULL {"n": -1}
+S: SUCCESS {"fields": ["x"]}
+   RECORD [1]
+   SUCCESS {"bookmark": "neo4j:bookmark-test-2", "type": "r", "t_last": 5, "db": "system"}
diff --git a/tests/stub/scripts/v4x2/return_1_noop_port_9001.script b/tests/stub/scripts/v4x2/return_1_noop_port_9001.script
@@ -0,0 +1,15 @@
+!: BOLT 4.2
+!: AUTO GOODBYE
+!: AUTO RESET
+!: PORT 9001
+
+C: HELLO {"user_agent": "test", "scheme": "basic", "principal": "test", "credentials": "test", "routing": {"address": "localhost:9001"}}
+S: SUCCESS {"server": "Neo4j/4.2.0", "connection_id": "123e4567-e89b-12d3-a456-426655440000"}
+C: RUN "RETURN 1 AS x" {} {"mode": "r"}
+   PULL {"n": 2}
+S: SUCCESS {"fields": ["x"]}
+   <NOOP>
+   <NOOP>
+   RECORD [1]
+   <NOOP>
+   SUCCESS {"bookmark": "neo4j:bookmark-test-1", "type": "r", "t_last": 5, "db": "neo4j"}
diff --git a/tests/stub/scripts/v4x2/return_1_port_9001_bogus_server.script b/tests/stub/scripts/v4x2/return_1_port_9001_bogus_server.script
@@ -0,0 +1,10 @@
+!: BOLT 4.2
+!: PORT 9001
+
+C: HELLO {"user_agent": "test", "scheme": "basic", "principal": "test", "credentials": "test", "routing": {"address": "localhost:9001"}}
+S: SUCCESS {"server": "Bogus/4.2.0", "connection_id": "123e4567-e89b-12d3-a456-426655440000"}
+C: RUN "RETURN 1 AS x" {} {"mode": "r"}
+   PULL {"n": -1}
+S: SUCCESS {"fields": ["x"]}
+   RECORD [1]
+   SUCCESS {"bookmark": "neo4j:bookmark-test-1", "type": "r", "t_last": 5, "db": "neo4j"}
diff --git a/tests/stub/scripts/v4x2/router_get_routing_table_with_context.script b/tests/stub/scripts/v4x2/router_get_routing_table_with_context.script
@@ -0,0 +1,12 @@
+!: BOLT 4.2
+!: AUTO GOODBYE
+!: AUTO RESET
+!: PORT 9001
+
+C: HELLO {"scheme": "basic", "principal": "test", "credentials": "test", "user_agent": "test", "routing": {"address": "localhost:9001", "policy": "my_policy", "region": "china"}}
+S: SUCCESS {"server": "Neo4j/4.2.0", "connection_id": "bolt-123456789"}
+C: RUN "CALL dbms.routing.getRoutingTable($context)" {"context": {"address": "localhost:9001", "policy": "my_policy", "region": "china"}} {"mode": "r", "db": "system"}
+   PULL {"n": -1}
+S: SUCCESS {"fields": ["ttl", "servers"]}
+   RECORD [4321, [{"addresses": ["127.0.0.1:9001"],"role": "WRITE"}, {"addresses": ["127.0.0.1:9002"], "role": "READ"}, {"addresses": ["127.0.0.1:9001", "127.0.0.1:9002"], "role": "ROUTE"}]]
+   SUCCESS {"bookmark": "neo4j:bookmark-test-1", "type": "r", "t_last": 5, "db": "system"}
diff --git a/tests/stub/test_directdriver.py b/tests/stub/test_directdriver.py
@@ -94,6 +94,7 @@ def test_bolt_uri_constructs_bolt_driver(driver_info, test_script):
         "v3/empty_explicit_hello_goodbye.script",
         "v4x0/empty_explicit_hello_goodbye.script",
         "v4x1/empty_explicit_hello_goodbye.script",
+        "v4x2/empty_explicit_hello_goodbye.script",
     ]
 )
 def test_direct_driver_handshake_negotiation(driver_info, test_script):
@@ -111,6 +112,7 @@ def test_direct_driver_handshake_negotiation(driver_info, test_script):
         ("v3/return_1_port_9001.script", "Neo4j/3.0.0"),
         ("v4x0/return_1_port_9001.script", "Neo4j/4.0.0"),
         ("v4x1/return_1_port_9001_bogus_server.script", DriverError),
+        ("v4x2/return_1_port_9001_bogus_server.script", DriverError),
     ]
 )
 def test_return_1_as_x(driver_info, test_script, test_expected):
@@ -602,6 +604,7 @@ def test_bolt_driver_explicit_transaction_consume_result_case_b(driver_info, tes
     "test_script",
     [
         "v4x1/return_1_noop_port_9001.script",
+        "v4x2/return_1_noop_port_9001.script",
     ]
 )
 def test_direct_can_handle_noop(driver_info, test_script):
diff --git a/tests/stub/test_routingdriver.py b/tests/stub/test_routingdriver.py
@@ -653,7 +653,8 @@ def test_forgets_address_on_database_unavailable_error(driver_info, test_scripts
 @pytest.mark.parametrize(
     "test_scripts",
     [
-        ("v4x1/router_get_routing_table_with_context.script", "v4x1/hello_with_routing_context_return_1_port_9002.script",),
+        ("v4x1/router_get_routing_table_with_context.script", "v4x2/hello_with_routing_context_return_1_port_9002.script",),
+        ("v4x1/router_get_routing_table_with_context.script", "v4x2/hello_with_routing_context_return_1_port_9002.script",),
     ]
 )
 def test_hello_routing(driver_info, test_scripts):
diff --git a/tests/unit/io/test_class_bolt4x2.py b/tests/unit/io/test_class_bolt4x2.py
@@ -0,0 +1,188 @@
+#!/usr/bin/env python
+# -*- encoding: utf-8 -*-
+
+# Copyright (c) 2002-2020 "Neo4j,"
+# Neo4j Sweden AB [http://neo4j.com]
+#
+# This file is part of Neo4j.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+import pytest
+
+from neo4j.io._bolt4 import Bolt4x2
+from neo4j.conf import PoolConfig
+
+
+def test_conn_timed_out(fake_socket):
+    address = ("127.0.0.1", 7687)
+    max_connection_lifetime = 0
+    connection = Bolt4x2(address, fake_socket(address), max_connection_lifetime)
+    assert connection.timedout() is True
+
+
+def test_conn_not_timed_out_if_not_enabled(fake_socket):
+    address = ("127.0.0.1", 7687)
+    max_connection_lifetime = -1
+    connection = Bolt4x2(address, fake_socket(address), max_connection_lifetime)
+    assert connection.timedout() is False
+
+
+def test_conn_not_timed_out(fake_socket):
+    address = ("127.0.0.1", 7687)
+    max_connection_lifetime = 999999999
+    connection = Bolt4x2(address, fake_socket(address), max_connection_lifetime)
+    assert connection.timedout() is False
+
+
+def test_db_extra_in_begin(fake_socket):
+    address = ("127.0.0.1", 7687)
+    socket = fake_socket(address)
+    connection = Bolt4x2(address, socket, PoolConfig.max_connection_lifetime)
+    connection.begin(db="something")
+    connection.send_all()
+    tag, fields = socket.pop_message()
+    assert tag == b"\x11"
+    assert len(fields) == 1
+    assert fields[0] == {"db": "something"}
+
+
+def test_db_extra_in_run(fake_socket):
+    address = ("127.0.0.1", 7687)
+    socket = fake_socket(address)
+    connection = Bolt4x2(address, socket, PoolConfig.max_connection_lifetime)
+    connection.run("", {}, db="something")
+    connection.send_all()
+    tag, fields = socket.pop_message()
+    assert tag == b"\x10"
+    assert len(fields) == 3
+    assert fields[0] == ""
+    assert fields[1] == {}
+    assert fields[2] == {"db": "something"}
+
+
+def test_n_extra_in_discard(fake_socket):
+    address = ("127.0.0.1", 7687)
+    socket = fake_socket(address)
+    connection = Bolt4x2(address, socket, PoolConfig.max_connection_lifetime)
+    connection.discard(n=666)
+    connection.send_all()
+    tag, fields = socket.pop_message()
+    assert tag == b"\x2F"
+    assert len(fields) == 1
+    assert fields[0] == {"n": 666}
+
+
+@pytest.mark.parametrize(
+    "test_input, expected",
+    [
+        (666, {"n": -1, "qid": 666}),
+        (-1, {"n": -1}),
+    ]
+)
+def test_qid_extra_in_discard(fake_socket, test_input, expected):
+    address = ("127.0.0.1", 7687)
+    socket = fake_socket(address)
+    connection = Bolt4x2(address, socket, PoolConfig.max_connection_lifetime)
+    connection.discard(qid=test_input)
+    connection.send_all()
+    tag, fields = socket.pop_message()
+    assert tag == b"\x2F"
+    assert len(fields) == 1
+    assert fields[0] == expected
+
+
+@pytest.mark.parametrize(
+    "test_input, expected",
+    [
+        (777, {"n": 666, "qid": 777}),
+        (-1, {"n": 666}),
+    ]
+)
+def test_n_and_qid_extras_in_discard(fake_socket, test_input, expected):
+    # python -m pytest tests/unit/io/test_class_bolt4x0.py -s -k test_n_and_qid_extras_in_discard
+    address = ("127.0.0.1", 7687)
+    socket = fake_socket(address)
+    connection = Bolt4x2(address, socket, PoolConfig.max_connection_lifetime)
+    connection.discard(n=666, qid=test_input)
+    connection.send_all()
+    tag, fields = socket.pop_message()
+    assert tag == b"\x2F"
+    assert len(fields) == 1
+    assert fields[0] == expected
+
+
+@pytest.mark.parametrize(
+    "test_input, expected",
+    [
+        (666, {"n": 666}),
+        (-1, {"n": -1}),
+    ]
+)
+def test_n_extra_in_pull(fake_socket, test_input, expected):
+    address = ("127.0.0.1", 7687)
+    socket = fake_socket(address)
+    connection = Bolt4x2(address, socket, PoolConfig.max_connection_lifetime)
+    connection.pull(n=test_input)
+    connection.send_all()
+    tag, fields = socket.pop_message()
+    assert tag == b"\x3F"
+    assert len(fields) == 1
+    assert fields[0] == expected
+
+
+@pytest.mark.parametrize(
+    "test_input, expected",
+    [
+        (777, {"n": -1, "qid": 777}),
+        (-1, {"n": -1}),
+    ]
+)
+def test_qid_extra_in_pull(fake_socket, test_input, expected):
+    # python -m pytest tests/unit/io/test_class_bolt4x0.py -s -k test_qid_extra_in_pull
+    address = ("127.0.0.1", 7687)
+    socket = fake_socket(address)
+    connection = Bolt4x2(address, socket, PoolConfig.max_connection_lifetime)
+    connection.pull(qid=test_input)
+    connection.send_all()
+    tag, fields = socket.pop_message()
+    assert tag == b"\x3F"
+    assert len(fields) == 1
+    assert fields[0] == expected
+
+
+def test_n_and_qid_extras_in_pull(fake_socket):
+    address = ("127.0.0.1", 7687)
+    socket = fake_socket(address)
+    connection = Bolt4x2(address, socket, PoolConfig.max_connection_lifetime)
+    connection.pull(n=666, qid=777)
+    connection.send_all()
+    tag, fields = socket.pop_message()
+    assert tag == b"\x3F"
+    assert len(fields) == 1
+    assert fields[0] == {"n": 666, "qid": 777}
+
+
+def test_hello_passes_routing_metadata(fake_socket_pair):
+    address = ("127.0.0.1", 7687)
+    sockets = fake_socket_pair(address)
+    # TODO helper method for encoding messages
+    sockets.server.sendall(b"\x00\x03\xB1\x70\xA0\x00\x00")
+    connection = Bolt4x2(address, sockets.client, PoolConfig.max_connection_lifetime,
+                         routing_context={"foo": "bar"})
+    connection.hello()
+    tag, fields = sockets.server.pop_message()
+    assert tag == 0x01
+    assert len(fields) == 1
+    assert fields[0]["routing"] == {"foo": "bar"}
