Implement GetServerInfo Handler with Routing Validation Fix and Full Testkit Integration #277

src/Basic/Driver.php

@@ -16,6 +16,7 @@
 use Laudis\Neo4j\Contracts\AuthenticateInterface;
 use Laudis\Neo4j\Contracts\DriverInterface;
 use Laudis\Neo4j\Databags\DriverConfiguration;
+use Laudis\Neo4j\Databags\ServerInfo;
 use Laudis\Neo4j\Databags\SessionConfiguration;
 use Laudis\Neo4j\DriverFactory;
 use Laudis\Neo4j\Formatter\SummarizedResultFormatter;
@@ -44,6 +45,11 @@ public function verifyConnectivity(?SessionConfiguration $config = null): bool
         return $this->driver->verifyConnectivity($config);
     }
 
+    public function getServerInfo(?SessionConfiguration $config = null): ServerInfo
+    {
+        return $this->driver->getServerInfo($config);
+    }
+
     public static function create(string|UriInterface $uri, ?DriverConfiguration $configuration = null, ?AuthenticateInterface $authenticate = null): self
     {
         $driver = DriverFactory::create($uri, $configuration, $authenticate, SummarizedResultFormatter::create());

src/Bolt/BoltDriver.php

@@ -25,6 +25,7 @@
 use Laudis\Neo4j\Contracts\DriverInterface;
 use Laudis\Neo4j\Contracts\SessionInterface;
 use Laudis\Neo4j\Databags\DriverConfiguration;
+use Laudis\Neo4j\Databags\ServerInfo;
 use Laudis\Neo4j\Databags\SessionConfiguration;
 use Laudis\Neo4j\Formatter\SummarizedResultFormatter;
 use Psr\Http\Message\UriInterface;
@@ -97,6 +98,23 @@ public function verifyConnectivity(?SessionConfiguration $config = null): bool
         return true;
     }
 
+    public function getServerInfo(?SessionConfiguration $config = null): ServerInfo
+    {
+        $config ??= SessionConfiguration::default();
+
+        $connection = GeneratorHelper::getReturnFromGenerator($this->pool->acquire($config));
+
+        $serverInfo = new ServerInfo(
+            $connection->getServerAddress(),
+            $connection->getProtocol(),
+            $connection->getServerAgent()
+        );
+
+        $this->pool->release($connection);
+
+        return $serverInfo;
+    }
+
     public function closeConnections(): void
     {
         $this->pool->close();

src/Bolt/ProtocolFactory.php

@@ -33,6 +33,7 @@ public function createProtocol(IConnection $connection): V4_4|V5|V5_1|V5_2|V5_3|
         }
 
         $bolt = new Bolt($connection);
+        // Offer protocol versions from newest to oldest (only 4.4 and above are supported)
         $bolt->setProtocolVersions('5.4.4', 4.4);
         $protocol = $bolt->build();
 

src/Contracts/DriverInterface.php

@@ -13,6 +13,7 @@
 
 namespace Laudis\Neo4j\Contracts;
 
+use Laudis\Neo4j\Databags\ServerInfo;
 use Laudis\Neo4j\Databags\SessionConfiguration;
 use Laudis\Neo4j\Types\CypherList;
 use Laudis\Neo4j\Types\CypherMap;
@@ -35,6 +36,11 @@ public function createSession(?SessionConfiguration $config = null): SessionInte
      */
     public function verifyConnectivity(?SessionConfiguration $config = null): bool;
 
+    /**
+     * Returns server information by establishing a connection.
+     */
+    public function getServerInfo(?SessionConfiguration $config = null): ServerInfo;
+
     /**
      * Closes all connections in the pool.
      */

src/Neo4j/Neo4jDriver.php

@@ -28,7 +28,9 @@
 use Laudis\Neo4j\Contracts\DriverInterface;
 use Laudis\Neo4j\Contracts\SessionInterface;
 use Laudis\Neo4j\Databags\DriverConfiguration;
+use Laudis\Neo4j\Databags\ServerInfo;
 use Laudis\Neo4j\Databags\SessionConfiguration;
+use Laudis\Neo4j\Enum\AccessMode;
 use Laudis\Neo4j\Formatter\SummarizedResultFormatter;
 use Psr\Http\Message\UriInterface;
 use Psr\Log\LogLevel;
@@ -99,6 +101,28 @@ public function verifyConnectivity(?SessionConfiguration $config = null): bool
         return true;
     }
 
+    public function getServerInfo(?SessionConfiguration $config = null): ServerInfo
+    {
+        $config ??= SessionConfiguration::default();
+
+        // Use READ access mode to connect to a follower (read server)
+        if ($config->getAccessMode() === null) {
+            $config = $config->withAccessMode(AccessMode::READ());
+        }
+
+        $connection = GeneratorHelper::getReturnFromGenerator($this->pool->acquire($config));
+
+        $serverInfo = new ServerInfo(
+            $connection->getServerAddress(),
+            $connection->getProtocol(),
+            $connection->getServerAgent()
+        );
+
+        $this->pool->release($connection);
+
+        return $serverInfo;
+    }
+
     public function closeConnections(): void
     {
         $this->pool->close();

testkit-backend/src/Handlers/ExecuteQuery.php

@@ -0,0 +1,186 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Neo4j PHP Client and Driver package.
+ *
+ * (c) Nagels <https://nagels.tech>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Laudis\Neo4j\TestkitBackend\Handlers;
+
+use Exception;
+use Laudis\Neo4j\Databags\Neo4jError;
+use Laudis\Neo4j\Databags\SessionConfiguration;
+use Laudis\Neo4j\Enum\AccessMode;
+use Laudis\Neo4j\Exception\Neo4jException;
+use Laudis\Neo4j\Exception\TransactionException;
+use Laudis\Neo4j\TestkitBackend\Contracts\RequestHandlerInterface;
+use Laudis\Neo4j\TestkitBackend\Contracts\TestkitResponseInterface;
+use Laudis\Neo4j\TestkitBackend\MainRepository;
+use Laudis\Neo4j\TestkitBackend\Requests\ExecuteQueryRequest;
+use Laudis\Neo4j\TestkitBackend\Responses\DriverErrorResponse;
+use Laudis\Neo4j\TestkitBackend\Responses\EagerResultResponse;
+use Symfony\Component\Uid\Uuid;
+
+/**
+ * @implements RequestHandlerInterface<ExecuteQueryRequest>
+ */
+final class ExecuteQuery implements RequestHandlerInterface
+{
+    public function __construct(
+        private MainRepository $repository,
+    ) {
+    }
+
+    /**
+     * @param ExecuteQueryRequest $request
+     */
+    public function handle($request): TestkitResponseInterface
+    {
+        try {
+            $driver = $this->repository->getDriver($request->getDriverId());
+
+            if (method_exists($driver, 'executeQuery')) {
+                return $this->handleWithExecuteQuery($driver, $request);
+            }
+
+            return $this->handleWithSession($driver, $request);
+        } catch (Exception $e) {
+            $uuid = Uuid::v4();
+
+            if ($e instanceof Neo4jException || $e instanceof TransactionException) {
+                return new DriverErrorResponse($uuid, $e);
+            }
+
+            $neo4jError = new Neo4jError(
+                $e->getMessage(),
+                (string) $e->getCode(),
+                'DatabaseError',
+                'Service',
+                'Service Unavailable'
+            );
+
+            return new DriverErrorResponse($uuid, new Neo4jException([$neo4jError], $e));
+        }
+    }
+
+    private function handleWithExecuteQuery($driver, ExecuteQueryRequest $request): TestkitResponseInterface
+    {
+        $config = $this->buildExecutionConfig($request->getConfig());
+        $params = $request->getParams() ?? [];
+
+        $eagerResult = $driver->executeQuery(
+            $request->getCypher(),
+            $params,
+            $config
+        );
+
+        $resultId = Uuid::v4();
+        $this->repository->addEagerResult($resultId, $eagerResult);
+
+        return new EagerResultResponse($resultId, $eagerResult);
+    }
+
+    private function handleWithSession($driver, ExecuteQueryRequest $request): TestkitResponseInterface
+    {
+        $config = $request->getConfig();
+
+        $sessionConfig = SessionConfiguration::default();
+
+        if (array_key_exists('database', $config)) {
+            $sessionConfig = $sessionConfig->withDatabase($config['database']);
+        }
+
+        $accessMode = AccessMode::READ();
+        if (array_key_exists('routing', $config) && $config['routing'] === 'w') {
+            $accessMode = AccessMode::WRITE();
+        }
+        $sessionConfig = $sessionConfig->withAccessMode($accessMode);
+
+        $session = $driver->createSession($sessionConfig);
+
+        try {
+            $result = $session->run(
+                $request->getCypher(),
+                $request->getParams() ?? []
+            );
+
+            $resultId = Uuid::v4();
+            $this->repository->addEagerResult($resultId, $result);
+
+            return new EagerResultResponse($resultId, $result);
+        } finally {
+            $session->close();
+        }
+    }
+
+    private function buildExecutionConfig(?array $config): array
+    {
+        if ($config === null) {
+            return [];
+        }
+
+        $executionConfig = [];
+
+        if (array_key_exists('database', $config) && $config['database'] !== null) {
+            $executionConfig['database'] = $config['database'];
+        }
+
+        if (array_key_exists('routing', $config) && $config['routing'] !== null) {
+            $executionConfig['routing'] = $config['routing'];
+        }
+
+        if (array_key_exists('impersonatedUser', $config) && $config['impersonatedUser'] !== null) {
+            $executionConfig['impersonatedUser'] = $config['impersonatedUser'];
+        }
+
+        if (array_key_exists('txMeta', $config) && $config['txMeta'] !== null) {
+            $executionConfig['txMeta'] = $config['txMeta'];
+        }
+
+        if (array_key_exists('timeout', $config) && $config['timeout'] !== null) {
+            $executionConfig['timeout'] = $config['timeout'] / 1000;
+        }
+
+        if (array_key_exists('authorizationToken', $config) && $config['authorizationToken'] !== null) {
+            $authToken = $config['authorizationToken'];
+            if (array_key_exists('data', $authToken)) {
+                $executionConfig['auth'] = $this->convertAuthToken($authToken['data']);
+            }
+        }
+
+        return $executionConfig;
+    }
+
+    private function convertAuthToken(array $tokenData): array
+    {
+        $auth = [];
+
+        if (array_key_exists('scheme', $tokenData)) {
+            $auth['scheme'] = $tokenData['scheme'];
+        }
+
+        if (array_key_exists('principal', $tokenData)) {
+            $auth['principal'] = $tokenData['principal'];
+        }
+
+        if (array_key_exists('credentials', $tokenData)) {
+            $auth['credentials'] = $tokenData['credentials'];
+        }
+
+        if (array_key_exists('realm', $tokenData)) {
+            $auth['realm'] = $tokenData['realm'];
+        }
+
+        if (array_key_exists('parameters', $tokenData)) {
+            $auth['parameters'] = $tokenData['parameters'];
+        }
+
+        return $auth;
+    }
+}

testkit-backend/src/Handlers/GetServerInfo.php

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Neo4j PHP Client and Driver package.
+ *
+ * (c) Nagels <https://nagels.tech>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Laudis\Neo4j\TestkitBackend\Handlers;
+
+use Exception;
+use Laudis\Neo4j\Databags\Neo4jError;
+use Laudis\Neo4j\Exception\Neo4jException;
+use Laudis\Neo4j\Exception\TransactionException;
+use Laudis\Neo4j\TestkitBackend\Contracts\RequestHandlerInterface;
+use Laudis\Neo4j\TestkitBackend\Contracts\TestkitResponseInterface;
+use Laudis\Neo4j\TestkitBackend\MainRepository;
+use Laudis\Neo4j\TestkitBackend\Requests\GetServerInfoRequest;
+use Laudis\Neo4j\TestkitBackend\Responses\DriverErrorResponse;
+use Laudis\Neo4j\TestkitBackend\Responses\ServerInfoResponse;
+use Symfony\Component\Uid\Uuid;
+
+/**
+ * @implements RequestHandlerInterface<GetServerInfoRequest>
+ */
+final class GetServerInfo implements RequestHandlerInterface
+{
+    public function __construct(
+        private MainRepository $repository,
+    ) {
+    }
+
+    /**
+     * @param GetServerInfoRequest $request
+     */
+    public function handle($request): TestkitResponseInterface
+    {
+        try {
+            $driver = $this->repository->getDriver($request->getDriverId());
+
+            $serverInfo = $driver->getServerInfo();
+
+            return new ServerInfoResponse($serverInfo);
+        } catch (Neo4jException|TransactionException $e) {
+            return new DriverErrorResponse(Uuid::v4(), $e);
+        } catch (Exception $e) {
+            $neo4jError = new Neo4jError(
+                $e->getMessage(),
+                (string) $e->getCode(),
+                'DatabaseError',
+                'Service',
+                'Service Unavailable'
+            );
+
+            return new DriverErrorResponse(Uuid::v4(), new Neo4jException([$neo4jError], $e));
+        }
+    }
+}

testkit-backend/src/MainRepository.php

@@ -68,6 +68,10 @@ public function addDriver(Uuid $id, DriverInterface $driver): void
 
     public function removeDriver(Uuid $id): void
     {
+        $driver = $this->drivers[$id->toRfc4122()] ?? null;
+        if ($driver !== null) {
+            $driver->closeConnections();
+        }
         unset($this->drivers[$id->toRfc4122()]);
     }
 

testkit-backend/src/RequestFactory.php

@@ -22,6 +22,7 @@
 use Laudis\Neo4j\TestkitBackend\Requests\ForcedRoutingTableUpdateRequest;
 use Laudis\Neo4j\TestkitBackend\Requests\GetFeaturesRequest;
 use Laudis\Neo4j\TestkitBackend\Requests\GetRoutingTableRequest;
+use Laudis\Neo4j\TestkitBackend\Requests\GetServerInfoRequest;
 use Laudis\Neo4j\TestkitBackend\Requests\NewDriverRequest;
 use Laudis\Neo4j\TestkitBackend\Requests\NewSessionRequest;
 use Laudis\Neo4j\TestkitBackend\Requests\ResolverResolutionCompletedRequest;
@@ -70,6 +71,7 @@ final class RequestFactory
         'RetryableNegative' => RetryableNegativeRequest::class,
         'ForcedRoutingTableUpdate' => ForcedRoutingTableUpdateRequest::class,
         'GetRoutingTable' => GetRoutingTableRequest::class,
+        'GetServerInfo' => GetServerInfoRequest::class,
     ];
 
     /**