Merge branch 'cacheing'

Author: transistive

composer.json

@@ -33,18 +33,23 @@
         "php-http/message-factory": "^1.0",
         "stefanak-michal/bolt": "^4.1",
         "symfony/polyfill-php80": "^1.2",
+        "psr/simple-cache": "^1.0",
         "ext-json": "*"
     },
+    "provide": {
+        "psr/simple-cache-implementation": "2.0|3.0"
+    },
     "suggest": {
         "ext-bcmath": "Needed to implement bolt protocol",
+        "ext-sysvsem": "Needed for enabling connection pooling between processes",
         "composer-runtime-api": "Install composer 2 for auto detection of version in user agent"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.0",
         "nyholm/psr7": "^1.3",
         "nyholm/psr7-server": "^1.0",
         "kriswallsmith/buzz": "^1.2",
-        "vimeo/psalm": "4.23.0",
+        "vimeo/psalm": "^4.27",
         "friendsofphp/php-cs-fixer": "3.8.0",
         "psalm/plugin-phpunit": "^0.15.1",
         "monolog/monolog": "^2.2",
@@ -54,7 +59,8 @@
         "psr/container": "^1.1",
         "lctrs/psalm-psr-container-plugin": "^1.3",
         "symfony/uid": "^5.0",
-        "symfony/var-dumper": "^5.0"
+        "symfony/var-dumper": "^5.0",
+        "cache/integration-tests": "dev-master"
     },
     "autoload": {
         "psr-4": {

src/Authentication/BasicAuth.php

@@ -62,4 +62,9 @@ public function authenticateBolt(V3 $bolt, string $userAgent): array
         /** @var array{server: string, connection_id: string, hints: list} */
         return $bolt->hello(Auth::basic($this->username, $this->password, $userAgent));
     }
+
+    public function toString(UriInterface $uri): string
+    {
+        return sprintf('Basic %s:%s@%s:%s', $this->username, '######', $uri->getHost(), $uri->getPort() ?? '');
+    }
 }

src/Authentication/KerberosAuth.php

@@ -18,6 +18,7 @@
 use Laudis\Neo4j\Contracts\AuthenticateInterface;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\UriInterface;
+use function sprintf;
 
 /**
  * Authenticates connections using a kerberos token.
@@ -53,4 +54,9 @@ public function authenticateBolt(V3 $bolt, string $userAgent): array
         /** @var array{server: string, connection_id: string, hints: list} */
         return $bolt->hello(Auth::bearer($this->token, $userAgent));
     }
+
+    public function toString(UriInterface $uri): string
+    {
+        return sprintf('Kerberos %s@%s:%s', $this->token, $uri->getHost(), $uri->getPort() ?? '');
+    }
 }

src/Authentication/NoAuth.php

@@ -18,6 +18,7 @@
 use Laudis\Neo4j\Contracts\AuthenticateInterface;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\UriInterface;
+use function sprintf;
 
 /**
  * Doesn't authenticate connections.
@@ -42,4 +43,9 @@ public function authenticateBolt(V3 $bolt, string $userAgent): array
         /** @var array{server: string, connection_id: string, hints: list} */
         return $bolt->hello(Auth::none($userAgent));
     }
+
+    public function toString(UriInterface $uri): string
+    {
+        return sprintf('No Auth %s:%s', $uri->getHost(), $uri->getPort() ?? '');
+    }
 }

src/Authentication/OpenIDConnectAuth.php

@@ -16,6 +16,7 @@
 use Laudis\Neo4j\Contracts\AuthenticateInterface;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\UriInterface;
+use function sprintf;
 
 final class OpenIDConnectAuth implements AuthenticateInterface
 {
@@ -48,4 +49,9 @@ public function authenticateBolt(V3 $bolt, string $userAgent): array
         /** @var array{server: string, connection_id: string, hints: list} */
         return $bolt->hello(Auth::bearer($this->token));
     }
+
+    public function toString(UriInterface $uri): string
+    {
+        return sprintf('OpenId %s@%s:%s', $this->token, $uri->getHost(), $uri->getPort() ?? '');
+    }
 }

src/Basic/Driver.php

@@ -56,7 +56,6 @@ public function verifyConnectivity(): bool
 
     /**
      * @param string|UriInterface $uri
-     * @pure
      */
     public static function create($uri, ?DriverConfiguration $configuration = null, ?AuthenticateInterface $authenticate = null): self
     {

src/Bolt/BoltConnection.php

@@ -13,40 +13,36 @@
 
 namespace Laudis\Neo4j\Bolt;
 
-use BadMethodCallException;
 use Bolt\error\IgnoredException;
 use Bolt\error\MessageException;
 use Bolt\protocol\V3;
 use Bolt\protocol\V4;
-use Laudis\Neo4j\BoltFactory;
+use function in_array;
 use Laudis\Neo4j\Common\ConnectionConfiguration;
+use Laudis\Neo4j\Contracts\AuthenticateInterface;
 use Laudis\Neo4j\Contracts\ConnectionInterface;
+use Laudis\Neo4j\Contracts\FormatterInterface;
 use Laudis\Neo4j\Databags\BookmarkHolder;
 use Laudis\Neo4j\Databags\DatabaseInfo;
-use Laudis\Neo4j\Databags\DriverConfiguration;
 use Laudis\Neo4j\Enum\AccessMode;
 use Laudis\Neo4j\Enum\ConnectionProtocol;
 use Laudis\Neo4j\Types\CypherList;
-use LogicException;
 use Psr\Http\Message\UriInterface;
-use RuntimeException;
 use function str_starts_with;
 use WeakReference;
 
 /**
- * @implements ConnectionInterface<V3>
+ * @implements ConnectionInterface<array{0: V3, 1: Connection}>
  *
- * @psalm-import-type BoltMeta from \Laudis\Neo4j\Contracts\FormatterInterface
+ * @psalm-import-type BoltMeta from FormatterInterface
  */
-final class BoltConnection implements ConnectionInterface
+class BoltConnection implements ConnectionInterface
 {
-    private ?V3 $boltProtocol;
+    private V3 $boltProtocol;
     /** @psalm-readonly */
     private ConnectionConfiguration $config;
-    /** @psalm-readonly */
-    private BoltFactory $factory;
+    private string $serverState;
 
-    private string $serverState = 'DISCONNECTED';
     /**
      * @note We are using references to "subscribed results" to maintain backwards compatibility and try and strike
      *       a balance between performance and ease of use.
@@ -61,30 +57,31 @@ final class BoltConnection implements ConnectionInterface
      * @var list<WeakReference<CypherList>>
      */
     private array $subscribedResults = [];
+    private AuthenticateInterface $auth;
+    private Connection $connection;
+    private string $userAgent;
 
-    /**
-     * @psalm-mutation-free
-     */
-    public function __construct(BoltFactory $factory, ?V3 $boltProtocol, ConnectionConfiguration $config)
+    public function getImplementation()
     {
-        $this->factory = $factory;
-        $this->boltProtocol = $boltProtocol;
-        $this->config = $config;
-        if ($boltProtocol) {
-            $this->serverState = 'READY';
-        }
+        return [$this->boltProtocol, $this->connection];
     }
 
     /**
      * @psalm-mutation-free
      */
-    public function getImplementation(): V3
+    public function __construct(V3 $protocol, Connection $connection, AuthenticateInterface $auth, string $userAgent, ConnectionConfiguration $config)
     {
-        if ($this->boltProtocol === null) {
-            throw new RuntimeException('Connection is closed');
-        }
+        $this->boltProtocol = $protocol;
+        $this->serverState = 'READY';
+        $this->auth = $auth;
+        $this->connection = $connection;
+        $this->userAgent = $userAgent;
+        $this->config = $config;
+    }
 
-        return $this->boltProtocol;
+    public function getEncryptionLevel(): string
+    {
+        return $this->connection->getEncryptionLevel();
     }
 
     /**
@@ -135,6 +132,11 @@ public function getDatabaseInfo(): ?DatabaseInfo
         return $this->config->getDatabaseInfo();
     }
 
+    public function getAuthentication(): AuthenticateInterface
+    {
+        return $this->auth;
+    }
+
     /**
      * @psalm-mutation-free
      */
@@ -143,37 +145,12 @@ public function isOpen(): bool
         return $this->serverState !== 'DISCONNECTED' && $this->serverState !== 'DEFUNCT';
     }
 
-    public function open(): void
-    {
-        if ($this->boltProtocol !== null) {
-            throw new BadMethodCallException('Cannot open a connection that is already open');
-        }
-
-        $this->boltProtocol = $this->factory->build()[0];
-    }
-
     public function setTimeout(float $timeout): void
     {
-        $this->factory->getConnection()->setTimeout($timeout);
+        $this->connection->setTimeout($timeout);
     }
 
-    /**
-     * Closes the connection.
-     *
-     * Any of the preconditioned states are: 'READY', 'STREAMING', 'TX_READY', 'TX_STREAMING', 'FAILED', 'INTERRUPTED'.
-     * Sends signal: 'DISCONNECT'
-     */
-    public function close(): void
-    {
-        $this->consumeResults();
-
-        $this->protocol()->goodbye();
-
-        $this->serverState = 'DEFUNCT';
-        $this->boltProtocol = null; // has to be set to null as the sockets don't recover nicely contrary to what the underlying code might lead you to believe
-    }
-
-    private function consumeResults(): void
+    public function consumeResults(): void
     {
         foreach ($this->subscribedResults as $result) {
             $result = $result->get();
@@ -230,11 +207,6 @@ public function begin(?string $database, ?float $timeout, BookmarkHolder $holder
         $this->serverState = 'TX_READY';
     }
 
-    public function getFactory(): BoltFactory
-    {
-        return $this->factory;
-    }
-
     /**
      * Discards a result.
      *
@@ -273,7 +245,7 @@ public function discard(?int $qid): void
      */
     public function run(string $text, array $parameters, ?string $database, ?float $timeout, BookmarkHolder $holder): array
     {
-        if (!str_starts_with($this->serverState, 'TX_') || str_starts_with($this->getServerVersion(), '3')) {
+        if (in_array($this->serverState, ['STREAMING', 'TX_STREAMING'])) {
             $this->consumeResults();
         }
 
@@ -349,6 +321,11 @@ public function rollback(): void
         $this->serverState = 'READY';
     }
 
+    public function protocol(): V3
+    {
+        return $this->boltProtocol;
+    }
+
     /**
      * Pulls a result set.
      *
@@ -363,10 +340,10 @@ public function pull(?int $qid, ?int $fetchSize): array
         $bolt = $this->protocol();
         try {
             if (!$bolt instanceof V4) {
-                /** @var non-empty-list<list> */
+                /** @var non-empty-list<list> $tbr */
                 $tbr = $bolt->pullAll($extra);
             } else {
-                /** @var non-empty-list<list> */
+                /** @var non-empty-list<list> $tbr */
                 $tbr = $bolt->pull($extra);
             }
         } catch (MessageException $e) {
@@ -384,18 +361,17 @@ public function pull(?int $qid, ?int $fetchSize): array
         return $tbr;
     }
 
-    /**
-     * @psalm-mutation-free
-     */
-    public function getDriverConfiguration(): DriverConfiguration
-    {
-        return $this->config->getDriverConfiguration();
-    }
-
     public function __destruct()
     {
         if ($this->serverState !== 'FAILED' && $this->isOpen()) {
-            $this->close();
+            if (in_array($this->serverState, ['STREAMING', 'TX_STREAMING'])) {
+                $this->consumeResults();
+            }
+
+            $this->protocol()->goodbye();
+
+            $this->serverState = 'DEFUNCT';
+            unset($this->boltProtocol); // has to be set to null as the sockets don't recover nicely contrary to what the underlying code might lead you to believe;
         }
     }
 
@@ -440,15 +416,6 @@ public function subscribeResult(CypherList $result): void
         $this->subscribedResults[] = WeakReference::create($result);
     }
 
-    private function protocol(): V3
-    {
-        if ($this->boltProtocol === null) {
-            throw new LogicException('Cannot use protocol if it is not created');
-        }
-
-        return $this->boltProtocol;
-    }
-
     private function interpretResult(array $result): void
     {
         if (str_starts_with($this->serverState, 'TX_')) {
@@ -475,4 +442,9 @@ private function countResults(): int
 
         return $ctr;
     }
+
+    public function getUserAgent(): string
+    {
+        return $this->userAgent;
+    }
 }