Merge pull request #154 from neo4j-php/bolt_57_58

stefanak-michal · web-flow · commit a285c4fd4509 · 2025-01-08T20:32:45.000+01:00
Bolt 5.7 and 5.8
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', '5.13', '5.23']
+        neo4j-version: ['5.4', '5.6', '5.8', '5.12', '5.13', '5.23', '5.26']
         php-version: ['8.1', '8.2', '8.3', '8.4']
 
     services:
diff --git a/README.md b/README.md
@@ -18,7 +18,7 @@ all available versions and keep up with protocol messages architecture and speci
 
 ## :label: Version support
 
-We are trying to keep up and this library supports **Bolt <= 5.6**.
+We are trying to keep up and this library supports **Bolt <= 5.8**.
 
 https://www.neo4j.com/docs/bolt/current/bolt-compatibility/
 
@@ -126,17 +126,17 @@ _`run` executes query in auto-commit transaction if explicit transaction was not
 
 ### Cypher query parameters
 
-| Neo4j      | PHP                                                                                                                               |
-|------------|-----------------------------------------------------------------------------------------------------------------------------------|
-| Null       | null                                                                                                                              |
-| Boolean    | boolean                                                                                                                           |
-| Integer    | integer                                                                                                                           |
-| Float      | float                                                                                                                             |
-| Bytes      | [Bytes class](https://github.com/neo4j-php/Bolt/blob/master/src/structures/Bytes.php)                                             |
-| String     | string                                                                                                                            |
-| List       | array with consecutive numeric keys from 0                                                                                        |
-| Dictionary | object or array which is not considered as list                                                                                   |
-| Structure  | Classes implementing `IStructure` by protocol version ([docs](https://www.neo4j.com/docs/bolt/current/bolt/structure-semantics/)) |
+| Neo4j      | PHP                                                                                                                                                             |
+|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Null       | null                                                                                                                                                            |
+| Boolean    | boolean                                                                                                                                                         |
+| Integer    | integer                                                                                                                                                         |
+| Float      | float                                                                                                                                                           |
+| Bytes      | [Bytes class]([https://github.com/neo4j-php/Bolt/blob/master/src/structures/Bytes.php](https://github.com/neo4j-php/Bolt/blob/master/src/packstream/Bytes.php)) |
+| String     | string                                                                                                                                                          |
+| List       | array with consecutive numeric keys from 0                                                                                                                      |
+| Dictionary | object or array which is not considered as list                                                                                                                 |
+| Structure  | Classes implementing `IStructure` by protocol version ([docs](https://www.neo4j.com/docs/bolt/current/bolt/structure-semantics/))                               |
 
 List or dictionary can be also provided as instance of class implementing `Bolt\packstream\IPackListGenerator`
 or `Bolt\PackStream\IPackDictionaryGenerator`. This approach helps with memory management while working with big amount
diff --git a/src/protocol/V5_6.php b/src/protocol/V5_6.php
@@ -3,7 +3,7 @@
 namespace Bolt\protocol;
 
 /**
- * Class Protocol version 5.4
+ * Class Protocol version 5.6
  *
  * @author Michal Stefanak
  * @link https://github.com/neo4j-php/Bolt
diff --git a/src/protocol/V5_7.php b/src/protocol/V5_7.php
@@ -0,0 +1,37 @@
+<?php
+
+namespace Bolt\protocol;
+
+/**
+ * Class Protocol version 5.7
+ *
+ * @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_7 extends AProtocol
+{
+    use \Bolt\protocol\v5\AvailableStructures;
+    use \Bolt\protocol\v5_1\ServerStateTransition;
+
+    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/V5_8.php b/src/protocol/V5_8.php
@@ -0,0 +1,37 @@
+<?php
+
+namespace Bolt\protocol;
+
+/**
+ * Class Protocol version 5.8
+ *
+ * @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_8 extends AProtocol
+{
+    use \Bolt\protocol\v5\AvailableStructures;
+    use \Bolt\protocol\v5_1\ServerStateTransition;
+
+    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/AckFailureMessage.php b/src/protocol/v1/AckFailureMessage.php
@@ -3,7 +3,6 @@
 namespace Bolt\protocol\v1;
 
 use Bolt\enum\Message;
-use Bolt\protocol\{V1, V2};
 use Bolt\error\BoltException;
 
 trait AckFailureMessage
@@ -16,7 +15,7 @@ trait AckFailureMessage
      * @link https://www.neo4j.com/docs/bolt/current/bolt/message/#messages-ack-failure
      * @throws BoltException
      */
-    public function ackFailure(): V1|V2
+    public function ackFailure(): static
     {
         $this->write($this->packer->pack(0x0E));
         $this->pipelinedMessages[] = Message::ACK_FAILURE;
diff --git a/src/protocol/v1/DiscardAllMessage.php b/src/protocol/v1/DiscardAllMessage.php
@@ -3,7 +3,6 @@
 namespace Bolt\protocol\v1;
 
 use Bolt\enum\Message;
-use Bolt\protocol\{V1, V2, V3};
 use Bolt\error\BoltException;
 
 trait DiscardAllMessage
@@ -15,7 +14,7 @@ trait DiscardAllMessage
      * https://www.neo4j.com/docs/bolt/current/bolt/message/#messages-discard
      * @throws BoltException
      */
-    public function discardAll(): V1|V2|V3
+    public function discardAll(): static
     {
         $this->write($this->packer->pack(0x2F));
         $this->pipelinedMessages[] = Message::DISCARD_ALL;
diff --git a/src/protocol/v1/InitMessage.php b/src/protocol/v1/InitMessage.php
@@ -3,7 +3,6 @@
 namespace Bolt\protocol\v1;
 
 use Bolt\enum\Message;
-use Bolt\protocol\{V1, V2};
 use Bolt\error\BoltException;
 
 trait InitMessage
@@ -15,7 +14,7 @@ trait InitMessage
      * @link https://www.neo4j.com/docs/bolt/current/bolt/message/#messages-init
      * @throws BoltException
      */
-    public function init(string $userAgent, array $authToken): V1|V2
+    public function init(string $userAgent, array $authToken): static
     {
         $this->write($this->packer->pack(0x01, $userAgent, $authToken));
         $this->pipelinedMessages[] = Message::INIT;
diff --git a/src/protocol/v1/PullAllMessage.php b/src/protocol/v1/PullAllMessage.php
@@ -3,12 +3,7 @@
 namespace Bolt\protocol\v1;
 
 use Bolt\enum\{Message, Signature};
-use Bolt\protocol\{
-    Response,
-    V1,
-    V2,
-    V3
-};
+use Bolt\protocol\Response;
 use Bolt\error\BoltException;
 
 trait PullAllMessage
@@ -20,7 +15,7 @@ trait PullAllMessage
      * @link https://www.neo4j.com/docs/bolt/current/bolt/message/#message-pull
      * @throws BoltException
      */
-    public function pullAll(): V1|V2|V3
+    public function pullAll(): static
     {
         $this->write($this->packer->pack(0x3F));
         $this->pipelinedMessages[] = Message::PULL_ALL;
diff --git a/src/protocol/v1/ResetMessage.php b/src/protocol/v1/ResetMessage.php
@@ -3,7 +3,6 @@
 namespace Bolt\protocol\v1;
 
 use Bolt\enum\Message;
-use Bolt\protocol\{V1, V2, V3, V4, V4_1, V4_2, V4_3, V4_4, V5, V5_1, V5_2, V5_3, V5_4, V5_6};
 use Bolt\error\BoltException;
 
 trait ResetMessage
@@ -15,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|V5_4|V5_6
+    public function reset(): static
     {
         $this->write($this->packer->pack(0x0F));
         $this->pipelinedMessages[] = Message::RESET;
diff --git a/src/protocol/v1/RunMessage.php b/src/protocol/v1/RunMessage.php
@@ -3,7 +3,6 @@
 namespace Bolt\protocol\v1;
 
 use Bolt\enum\Message;
-use Bolt\protocol\{V1, V2};
 use Bolt\error\BoltException;
 
 trait RunMessage
@@ -15,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 = []): V1|V2
+    public function run(string $query, array $parameters = []): static
     {
         $this->write($this->packer->pack(0x10, $query, (object)$parameters));
         $this->pipelinedMessages[] = Message::RUN;
diff --git a/src/protocol/v3/BeginMessage.php b/src/protocol/v3/BeginMessage.php
@@ -3,7 +3,6 @@
 namespace Bolt\protocol\v3;
 
 use Bolt\enum\Message;
-use Bolt\protocol\{V3, V4, V4_1, V4_2, V4_3, V4_4, V5, V5_1, V5_2, V5_3, V5_4, V5_6};
 use Bolt\error\BoltException;
 
 trait BeginMessage
@@ -15,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|V5_4|V5_6
+    public function begin(array $extra = []): static
     {
         $this->write($this->packer->pack(0x11, (object)$extra));
         $this->pipelinedMessages[] = Message::BEGIN;
diff --git a/src/protocol/v3/CommitMessage.php b/src/protocol/v3/CommitMessage.php
@@ -3,7 +3,7 @@
 namespace Bolt\protocol\v3;
 
 use Bolt\enum\Message;
-use Bolt\protocol\{Response, V3, V4, V4_1, V4_2, V4_3, V4_4, V5, V5_1, V5_2, V5_3, V5_4, V5_6};
+use Bolt\protocol\Response;
 use Bolt\error\BoltException;
 
 trait CommitMessage
@@ -15,7 +15,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|V5_4|V5_6
+    public function commit(): static
     {
         $this->write($this->packer->pack(0x12));
         $this->pipelinedMessages[] = Message::COMMIT;
diff --git a/src/protocol/v3/HelloMessage.php b/src/protocol/v3/HelloMessage.php
@@ -3,7 +3,6 @@
 namespace Bolt\protocol\v3;
 
 use Bolt\enum\Message;
-use Bolt\protocol\{V3, V4, V4_1, V4_2, V4_3, V4_4, V5};
 use Bolt\error\BoltException;
 
 trait HelloMessage
@@ -16,7 +15,7 @@ trait HelloMessage
      * @param array $extra Use \Bolt\helpers\Auth to generate appropriate array
      * @throws BoltException
      */
-    public function hello(array $extra): V3|V4|V4_1|V4_2|V4_3|V4_4|V5
+    public function hello(array $extra): static
     {
         $this->write($this->packer->pack(0x01, $extra));
         $this->pipelinedMessages[] = Message::HELLO;
diff --git a/src/protocol/v3/RollbackMessage.php b/src/protocol/v3/RollbackMessage.php
@@ -3,7 +3,7 @@
 namespace Bolt\protocol\v3;
 
 use Bolt\enum\Message;
-use Bolt\protocol\{Response, V3, V4, V4_1, V4_2, V4_3, V4_4, V5, V5_1, V5_2, V5_3, V5_4, V5_6};
+use Bolt\protocol\Response;
 use Bolt\error\BoltException;
 
 trait RollbackMessage
@@ -15,7 +15,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|V5_4|V5_6
+    public function rollback(): static
     {
         $this->write($this->packer->pack(0x13));
         $this->pipelinedMessages[] = Message::ROLLBACK;
diff --git a/src/protocol/v3/RunMessage.php b/src/protocol/v3/RunMessage.php
@@ -3,7 +3,7 @@
 namespace Bolt\protocol\v3;
 
 use Bolt\enum\Message;
-use Bolt\protocol\{Response, V3, V4, V4_1, V4_2, V4_3, V4_4, V5, V5_1, V5_2, V5_3, V5_4, V5_6};
+use Bolt\protocol\Response;
 use Bolt\error\BoltException;
 
 trait RunMessage
@@ -15,7 +15,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|V5_4|V5_6
+    public function run(string $query, array $parameters = [], array $extra = []): static
     {
         $this->write($this->packer->pack(
             0x10,
diff --git a/src/protocol/v4/DiscardMessage.php b/src/protocol/v4/DiscardMessage.php
@@ -4,7 +4,7 @@
 
 use Bolt\enum\Message;
 use Bolt\enum\Signature;
-use Bolt\protocol\{Response, V4, V4_1, V4_2, V4_3, V4_4, V5, V5_1, V5_2, V5_3, V5_4, V5_6};
+use Bolt\protocol\Response;
 use Bolt\error\BoltException;
 
 trait DiscardMessage
@@ -17,7 +17,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|V5_4|V5_6
+    public function discard(array $extra = []): static
     {
         if (!array_key_exists('n', $extra))
             $extra['n'] = -1;
diff --git a/src/protocol/v4/PullMessage.php b/src/protocol/v4/PullMessage.php
@@ -3,7 +3,7 @@
 namespace Bolt\protocol\v4;
 
 use Bolt\enum\{Message, Signature};
-use Bolt\protocol\{Response, V4, V4_1, V4_2, V4_3, V4_4, V5, V5_1, V5_2, V5_3, V5_4, V5_6};
+use Bolt\protocol\Response;
 use Bolt\error\BoltException;
 
 trait PullMessage
@@ -16,7 +16,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|V5_4|V5_6
+    public function pull(array $extra = []): static
     {
         if (!array_key_exists('n', $extra))
             $extra['n'] = -1;
diff --git a/src/protocol/v4_1/HelloMessage.php b/src/protocol/v4_1/HelloMessage.php
@@ -2,7 +2,6 @@
 
 namespace Bolt\protocol\v4_1;
 
-use Bolt\protocol\{V3, V4, V4_1, V4_2, V4_3, V4_4, V5};
 use Bolt\error\BoltException;
 
 trait HelloMessage
@@ -19,7 +18,7 @@ trait HelloMessage
      * @param array $extra Use \Bolt\helpers\Auth to generate appropiate array
      * @throws BoltException
      */
-    public function hello(array $extra): V3|V4|V4_1|V4_2|V4_3|V4_4|V5
+    public function hello(array $extra): static
     {
         if (isset($extra['routing']) && is_array($extra['routing']))
             $extra['routing'] = (object)$extra['routing'];
diff --git a/src/protocol/v4_3/RouteMessage.php b/src/protocol/v4_3/RouteMessage.php
@@ -3,7 +3,6 @@
 namespace Bolt\protocol\v4_3;
 
 use Bolt\enum\Message;
-use Bolt\protocol\{V4_3};
 use Bolt\error\BoltException;
 
 trait RouteMessage
@@ -15,7 +14,7 @@ trait RouteMessage
      * @link https://www.neo4j.com/docs/bolt/current/bolt/message/#messages-route
      * @throws BoltException
      */
-    public function route(array $routing, array $bookmarks = [], ?string $db = null): V4_3
+    public function route(array $routing, array $bookmarks = [], ?string $db = null): static
     {
         $this->write($this->packer->pack(0x66, (object)$routing, $bookmarks, $db));
         $this->pipelinedMessages[] = Message::ROUTE;
diff --git a/src/protocol/v4_4/RouteMessage.php b/src/protocol/v4_4/RouteMessage.php
diff --git a/src/protocol/v5_1/HelloMessage.php b/src/protocol/v5_1/HelloMessage.php
diff --git a/src/protocol/v5_1/LogoffMessage.php b/src/protocol/v5_1/LogoffMessage.php
diff --git a/src/protocol/v5_1/LogonMessage.php b/src/protocol/v5_1/LogonMessage.php
diff --git a/src/protocol/v5_3/HelloMessage.php b/src/protocol/v5_3/HelloMessage.php
diff --git a/src/protocol/v5_4/TelemetryMessage.php b/src/protocol/v5_4/TelemetryMessage.php
diff --git a/tests/TestLayer.php b/tests/TestLayer.php
diff --git a/tests/protocol/V5_7Test.php b/tests/protocol/V5_7Test.php
diff --git a/tests/protocol/V5_8Test.php b/tests/protocol/V5_8Test.php

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`namespace Bolt\protocol;`
`4`	`4`
`5`	`5`	`/**`
`6`		`- * Class Protocol version 5.4`
	`6`	`+ * Class Protocol version 5.6`
`7`	`7`	`*`
`8`	`8`	`* @author Michal Stefanak`
`9`	`9`	`* @link https://github.com/neo4j-php/Bolt`