Merge pull request #58 from transistive/route-message

Route message

Author: stefanak-michal

src/Bolt.php

@@ -45,7 +45,7 @@ final class Bolt
     /**
      * @var array
      */
-    private $versions = [4.1, 4, 3];
+    private $versions = [4.3, 4.1, 4, 3];
 
     /**
      * @var float
@@ -388,4 +388,20 @@ public function __destruct()
         $this->connection->disconnect();
     }
 
+    /**
+     * fetch the current routing table, if the message specification allows it.
+     *
+     * @param array|null $routing
+     *
+     * @return array{rt: array{servers: list<array{addresses: list<string>, role: 'WRITE'|'READ'|'ROUTE'}>, ttl: int}}|null
+     */
+    public function route(?array $routing = null): ?array
+    {
+        if (!method_exists($this->protocol, 'route')) {
+            return null;
+        }
+
+        $routing = $routing ?? ['address' => $this->connection->getIp() . ':' . $this->connection->getPort()];
+        return $this->protocol->route($routing);
+    }
 }

src/connection/AConnection.php

@@ -56,4 +56,19 @@ protected function printHex(string $str, bool $write = true)
         }
         echo '</pre>';
     }
+
+    public function getIp(): string
+    {
+        return $this->ip;
+    }
+
+    public function getPort(): int
+    {
+        return $this->port;
+    }
+
+    public function getTimeout(): float
+    {
+        return $this->timeout;
+    }
 }

src/connection/IConnection.php

@@ -25,4 +25,10 @@ public function write(string $buffer);
     public function read(int $length = 2048): string;
 
     public function disconnect();
+
+    public function getIp(): string;
+
+    public function getPort(): int;
+
+    public function getTimeout(): float;
 }

src/connection/Socket.php

@@ -125,5 +125,4 @@ public function disconnect()
             @socket_close($this->socket);
         }
     }
-
 }

src/protocol/V4_3.php

@@ -2,6 +2,9 @@
 
 namespace Bolt\protocol;
 
+use Bolt\error\MessageException;
+use Bolt\error\PackException;
+
 /**
  * Class Protocol version 4.3
  *
@@ -11,5 +14,21 @@
  */
 class V4_3 extends V4_1
 {
+    public function route(...$args): array
+    {
+        if (count($args) < 1) {
+            throw new PackException('Wrong arguments count');
+        }
+
+        $this->write($this->packer->pack(0x66, (object) $args[0], $args[1] ?? [], $args[2] ?? null));
+
+        $signature = 0;
+        $output = $this->read($signature);
+
+        if ($signature === self::FAILURE) {
+            throw new MessageException($output['message'] . ' (' . $output['code'] . ')');
+        }
 
+        return $signature === self::SUCCESS ? $output : [];
+    }
 }

tests/BoltTest.php

@@ -165,4 +165,20 @@ private function formatParameter(Bolt $bolt, string $name): string
         return self::$parameterType ? ('{' . $name . '}') : ('$' . $name);
     }
 
+
+
+    /**
+     * @depends testHello
+     * @param Bolt $bolt
+     */
+    public function testRoute(Bolt $bolt): void
+    {
+        $version = $bolt->getProtocolVersion();
+        if ($version >= 4.3) {
+            $route = $bolt->route();
+            self::assertNotEmpty($route);
+        } else {
+            self::assertNull($bolt->route());
+        }
+    }
 }