v54 (#125)

stefanak-michal · web-flow · commit 9ea1b553b77f · 2023-11-16T18:19:02.000+01:00
* Added support for 5.4. Missing tests because Neo4j 5.13 not available yet.

* Uncommented new version for compatibility

* Added new message
diff --git a/.github/workflows/db.50.2204.yml b/.github/workflows/db.50.2204.yml
@@ -13,7 +13,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        neo4j-version: ['5.4', '5.6', '5.8', '5.12']
+        neo4j-version: ['5.4', '5.6', '5.8', '5.12', '5.13']
         php-version: ['8.0', '8.1', '8.2']
 
     services:
diff --git a/README.md b/README.md
@@ -16,7 +16,7 @@ all available versions and keep up with protocol messages architecture and speci
 
 ## Version support
 
-We are trying to keep up and this library supports **Bolt <= 5.3**.
+We are trying to keep up and this library supports **Bolt <= 5.4**.
 
 https://www.neo4j.com/docs/bolt/current/bolt-compatibility/
 
@@ -121,6 +121,7 @@ foreach ($protocol->getResponses() as $response) {
 | commit            | Commit transaction                                           |                                                                    |
 | rollback          | Rollback transaction                                         |                                                                    |
 | reset             | Send message to reset connection                             |                                                                    |
+| telemetry         |                                                              | int $api                                                           |
 | getVersion        | Get used protocol version                                    |                                                                    |
 | getResponse       | Get waiting response from server                             |                                                                    |
 | getResponses      | Get waiting responses from server                            |                                                                    |
diff --git a/src/protocol/Response.php b/src/protocol/Response.php
@@ -25,6 +25,7 @@ class Response
     public const MESSAGE_ACK_FAILURE = 'ACK_FAILURE';
     public const MESSAGE_LOGON = 'LOGON';
     public const MESSAGE_LOGOFF = 'LOGOFF';
+    public const MESSAGE_TELEMETRY = 'TELEMETRY';
 
     public const SIGNATURE_SUCCESS = 0x70; //112
     public const SIGNATURE_FAILURE = 0x7F; //127
diff --git a/src/protocol/V5_4.php b/src/protocol/V5_4.php
@@ -0,0 +1,36 @@
+<?php
+
+namespace Bolt\protocol;
+
+/**
+ * Class Protocol version 5.4
+ *
+ * @author Michal Stefanak
+ * @link https://github.com/neo4j-php/Bolt
+ * @see https://www.neo4j.com/docs/bolt/current/bolt/message/
+ * @package Bolt\protocol
+ */
+class V5_4 extends AProtocol
+{
+    use \Bolt\protocol\v5\AvailableStructures;
+
+    use \Bolt\protocol\v1\ResetMessage;
+
+    use \Bolt\protocol\v3\RunMessage;
+    use \Bolt\protocol\v3\BeginMessage;
+    use \Bolt\protocol\v3\CommitMessage;
+    use \Bolt\protocol\v3\RollbackMessage;
+    use \Bolt\protocol\v3\GoodbyeMessage;
+
+    use \Bolt\protocol\v4\PullMessage;
+    use \Bolt\protocol\v4\DiscardMessage;
+
+    use \Bolt\protocol\v4_4\RouteMessage;
+
+    use \Bolt\protocol\v5_1\LogonMessage;
+    use \Bolt\protocol\v5_1\LogoffMessage;
+
+    use \Bolt\protocol\v5_3\HelloMessage;
+
+    use \Bolt\protocol\v5_4\TelemetryMessage;
+}
diff --git a/src/protocol/v1/ResetMessage.php b/src/protocol/v1/ResetMessage.php
@@ -2,7 +2,7 @@
 
 namespace Bolt\protocol\v1;
 
-use Bolt\protocol\{ServerState, Response, V1, V2, V3, V4, V4_1, V4_2, V4_3, V4_4, V5, V5_1, V5_2, V5_3};
+use Bolt\protocol\{ServerState, Response, V1, V2, V3, V4, V4_1, V4_2, V4_3, V4_4, V5, V5_1, V5_2, V5_3, V5_4};
 use Bolt\error\BoltException;
 
 trait ResetMessage
@@ -14,7 +14,7 @@ trait ResetMessage
      * @link https://www.neo4j.com/docs/bolt/current/bolt/message/#messages-reset
      * @throws BoltException
      */
-    public function reset(): V1|V2|V3|V4|V4_1|V4_2|V4_3|V4_4|V5|V5_1|V5_2|V5_3
+    public function reset(): V1|V2|V3|V4|V4_1|V4_2|V4_3|V4_4|V5|V5_1|V5_2|V5_3|V5_4
     {
         $this->write($this->packer->pack(0x0F));
         $this->pipelinedMessages[] = __FUNCTION__;
diff --git a/src/protocol/v3/BeginMessage.php b/src/protocol/v3/BeginMessage.php
@@ -2,7 +2,7 @@
 
 namespace Bolt\protocol\v3;
 
-use Bolt\protocol\{ServerState, Response, V3, V4, V4_1, V4_2, V4_3, V4_4, V5, V5_1, V5_2, V5_3};
+use Bolt\protocol\{ServerState, Response, V3, V4, V4_1, V4_2, V4_3, V4_4, V5, V5_1, V5_2, V5_3, V5_4};
 use Bolt\error\BoltException;
 
 trait BeginMessage
@@ -14,7 +14,7 @@ trait BeginMessage
      * @link https://www.neo4j.com/docs/bolt/current/bolt/message/#messages-begin
      * @throws BoltException
      */
-    public function begin(array $extra = []): V3|V4|V4_1|V4_2|V4_3|V4_4|V5|V5_1|V5_2|V5_3
+    public function begin(array $extra = []): V3|V4|V4_1|V4_2|V4_3|V4_4|V5|V5_1|V5_2|V5_3|V5_4
     {
         $this->serverState->is(ServerState::READY);
         $this->write($this->packer->pack(0x11, (object)$extra));
diff --git a/src/protocol/v3/CommitMessage.php b/src/protocol/v3/CommitMessage.php
@@ -2,7 +2,7 @@
 
 namespace Bolt\protocol\v3;
 
-use Bolt\protocol\{ServerState, Response, V3, V4, V4_1, V4_2, V4_3, V4_4, V5, V5_1, V5_2, V5_3};
+use Bolt\protocol\{ServerState, Response, V3, V4, V4_1, V4_2, V4_3, V4_4, V5, V5_1, V5_2, V5_3, V5_4};
 use Bolt\error\BoltException;
 
 trait CommitMessage
@@ -14,7 +14,7 @@ trait CommitMessage
      * @link https://www.neo4j.com/docs/bolt/current/bolt/message/#messages-commit
      * @throws BoltException
      */
-    public function commit(): V3|V4|V4_1|V4_2|V4_3|V4_4|V5|V5_1|V5_2|V5_3
+    public function commit(): V3|V4|V4_1|V4_2|V4_3|V4_4|V5|V5_1|V5_2|V5_3|V5_4
     {
         $this->serverState->is(ServerState::TX_READY, ServerState::TX_STREAMING);
         $this->write($this->packer->pack(0x12));
diff --git a/src/protocol/v3/RollbackMessage.php b/src/protocol/v3/RollbackMessage.php
@@ -2,7 +2,7 @@
 
 namespace Bolt\protocol\v3;
 
-use Bolt\protocol\{ServerState, Response, V3, V4, V4_1, V4_2, V4_3, V4_4, V5, V5_1, V5_2, V5_3};
+use Bolt\protocol\{ServerState, Response, V3, V4, V4_1, V4_2, V4_3, V4_4, V5, V5_1, V5_2, V5_3, V5_4};
 use Bolt\error\BoltException;
 
 trait RollbackMessage
@@ -14,7 +14,7 @@ trait RollbackMessage
      * @link https://www.neo4j.com/docs/bolt/current/bolt/message/#messages-rollback
      * @throws BoltException
      */
-    public function rollback(): V3|V4|V4_1|V4_2|V4_3|V4_4|V5|V5_1|V5_2|V5_3
+    public function rollback(): V3|V4|V4_1|V4_2|V4_3|V4_4|V5|V5_1|V5_2|V5_3|V5_4
     {
         $this->serverState->is(ServerState::TX_READY, ServerState::TX_STREAMING);
         $this->write($this->packer->pack(0x13));
diff --git a/src/protocol/v3/RunMessage.php b/src/protocol/v3/RunMessage.php
@@ -2,7 +2,7 @@
 
 namespace Bolt\protocol\v3;
 
-use Bolt\protocol\{ServerState, Response, V3, V4, V4_1, V4_2, V4_3, V4_4, V5, V5_1, V5_2, V5_3};
+use Bolt\protocol\{ServerState, Response, V3, V4, V4_1, V4_2, V4_3, V4_4, V5, V5_1, V5_2, V5_3, V5_4};
 use Bolt\error\BoltException;
 
 trait RunMessage
@@ -14,7 +14,7 @@ trait RunMessage
      * @link https://www.neo4j.com/docs/bolt/current/bolt/message/#messages-run
      * @throws BoltException
      */
-    public function run(string $query, array $parameters = [], array $extra = []): V3|V4|V4_1|V4_2|V4_3|V4_4|V5|V5_1|V5_2|V5_3
+    public function run(string $query, array $parameters = [], array $extra = []): V3|V4|V4_1|V4_2|V4_3|V4_4|V5|V5_1|V5_2|V5_3|V5_4
     {
         $this->serverState->is(ServerState::READY, ServerState::TX_READY, ServerState::STREAMING, ServerState::TX_STREAMING);
 
diff --git a/src/protocol/v4/DiscardMessage.php b/src/protocol/v4/DiscardMessage.php
@@ -2,7 +2,7 @@
 
 namespace Bolt\protocol\v4;
 
-use Bolt\protocol\{ServerState, Response, V4, V4_1, V4_2, V4_3, V4_4, V5, V5_1, V5_2, V5_3};
+use Bolt\protocol\{ServerState, Response, V4, V4_1, V4_2, V4_3, V4_4, V5, V5_1, V5_2, V5_3, V5_4};
 use Bolt\error\BoltException;
 
 trait DiscardMessage
@@ -15,7 +15,7 @@ trait DiscardMessage
      * @param array $extra [n::Integer, qid::Integer]
      * @throws BoltException
      */
-    public function discard(array $extra = []): V4|V4_1|V4_2|V4_3|V4_4|V5|V5_1|V5_2|V5_3
+    public function discard(array $extra = []): V4|V4_1|V4_2|V4_3|V4_4|V5|V5_1|V5_2|V5_3|V5_4
     {
         $this->serverState->is(ServerState::READY, ServerState::TX_READY, ServerState::STREAMING, ServerState::TX_STREAMING);
 
diff --git a/src/protocol/v4/PullMessage.php b/src/protocol/v4/PullMessage.php
@@ -2,7 +2,7 @@
 
 namespace Bolt\protocol\v4;
 
-use Bolt\protocol\{ServerState, Response, V4, V4_1, V4_2, V4_3, V4_4, V5, V5_1, V5_2, V5_3};
+use Bolt\protocol\{ServerState, Response, V4, V4_1, V4_2, V4_3, V4_4, V5, V5_1, V5_2, V5_3, V5_4};
 use Bolt\error\BoltException;
 
 trait PullMessage
@@ -15,7 +15,7 @@ trait PullMessage
      * @param array $extra [n::Integer, qid::Integer]
      * @throws BoltException
      */
-    public function pull(array $extra = []): V4|V4_1|V4_2|V4_3|V4_4|V5|V5_1|V5_2|V5_3
+    public function pull(array $extra = []): V4|V4_1|V4_2|V4_3|V4_4|V5|V5_1|V5_2|V5_3|V5_4
     {
         $this->serverState->is(ServerState::READY, ServerState::TX_READY, ServerState::STREAMING, ServerState::TX_STREAMING);
 
diff --git a/src/protocol/v4_4/RouteMessage.php b/src/protocol/v4_4/RouteMessage.php
@@ -2,7 +2,7 @@
 
 namespace Bolt\protocol\v4_4;
 
-use Bolt\protocol\{ServerState, Response, V4_4, V5, V5_1, V5_2, V5_3};
+use Bolt\protocol\{ServerState, Response, V4_4, V5, V5_1, V5_2, V5_3, V5_4};
 use Bolt\error\BoltException;
 
 trait RouteMessage
@@ -15,7 +15,7 @@ trait RouteMessage
      * @param array $extra [db::String, imp_user::String]
      * @throws BoltException
      */
-    public function route(array $routing, array $bookmarks = [], array $extra = []): V4_4|V5|V5_1|V5_2|V5_3
+    public function route(array $routing, array $bookmarks = [], array $extra = []): V4_4|V5|V5_1|V5_2|V5_3|V5_4
     {
         $this->serverState->is(ServerState::READY);
         $this->write($this->packer->pack(0x66, (object)$routing, $bookmarks, (object)$extra));
diff --git a/src/protocol/v5_4/TelemetryMessage.php b/src/protocol/v5_4/TelemetryMessage.php
@@ -0,0 +1,31 @@
+<?php
+
+namespace Bolt\protocol\v5_4;
+
+use Bolt\error\BoltException;
+use Bolt\protocol\Response;
+use Bolt\protocol\ServerState;
+
+trait TelemetryMessage
+{
+    /**
+     * Send TELEMETRY message
+     * The TELEMETRY message contains an integer representing which driver API was used.
+     *
+     * @link https://neo4j.com/docs/bolt/current/bolt/message/#messages-telemetry
+     * @param int $api
+     * @return Response
+     * @throws BoltException
+     */
+    public function telemetry(int $api): Response
+    {
+        $this->write($this->packer->pack(0x54, $api));
+        $content = $this->read($signature);
+
+        if ($signature === Response::SIGNATURE_FAILURE) {
+            $this->serverState->set(ServerState::FAILED);
+        }
+
+        return new Response(Response::MESSAGE_TELEMETRY, $signature, $content);
+    }
+}
diff --git a/tests/ATest.php b/tests/ATest.php
@@ -59,6 +59,7 @@ protected function sayHello(AProtocol $protocol, string $name, string $password)
      * Neo4j version is received by HTTP request on browser port
      * @param string|null $url
      * @return float|int
+     * @link https://neo4j.com/docs/http-api/current/endpoints/#discovery-api
      */
     protected function getCompatibleBoltVersion(string $url = null): float|int
     {
@@ -69,8 +70,8 @@ protected function getCompatibleBoltVersion(string $url = null): float|int
 
         $neo4jVersion = $decoded['neo4j_version'];
 
-//        if (version_compare($neo4jVersion, '5.13', '>='))
-//            return 5.4;
+        if (version_compare($neo4jVersion, '5.13', '>='))
+            return 5.4;
         if (version_compare($neo4jVersion, '5.9', '>='))
             return 5.3;
         if (version_compare($neo4jVersion, '5.7', '>='))
diff --git a/tests/protocol/V5_4Test.php b/tests/protocol/V5_4Test.php
@@ -0,0 +1,33 @@
+<?php
+
+use Bolt\protocol\Response;
+use Bolt\protocol\ServerState;
+use Bolt\protocol\V5_4;
+
+/**
+ * Class V5_4Test
+ *
+ * @author Michal Stefanak
+ * @link https://github.com/neo4j-php/Bolt
+ * @package Bolt\tests\protocol
+ */
+class V5_4Test extends \Bolt\tests\protocol\ATest
+{
+    public function test__construct(): V5_4
+    {
+        $cls = new V5_4(1, $this->mockConnection(), new \Bolt\protocol\ServerState());
+        $this->assertInstanceOf(V5_4::class, $cls);
+        $cls->serverState->expectedServerStateMismatchCallback = function (string $current, array $expected) {
+            $this->markTestIncomplete('Server in ' . $current . ' state. Expected ' . implode(' or ', $expected) . '.');
+        };
+        return $cls;
+    }
+
+    /**
+     * @depends test__construct
+     */
+    public function testTelemetry(V5_4 $cls): void
+    {
+        // todo
+    }
+}
