tested connection factory

transistive · transistive · commit d557e05efa78 · 2022-09-02T11:29:29.000+05:30
diff --git a/src/Authentication/NoAuth.php b/src/Authentication/NoAuth.php
@@ -18,7 +18,6 @@
 use Laudis\Neo4j\Contracts\AuthenticateInterface;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\UriInterface;
-
 use function sprintf;
 
 /**
diff --git a/src/Authentication/OpenIDConnectAuth.php b/src/Authentication/OpenIDConnectAuth.php
@@ -16,7 +16,6 @@
 use Laudis\Neo4j\Contracts\AuthenticateInterface;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\UriInterface;
-
 use function sprintf;
 
 final class OpenIDConnectAuth implements AuthenticateInterface
diff --git a/src/Bolt/BoltConnection.php b/src/Bolt/BoltConnection.php
@@ -13,7 +13,6 @@
 
 namespace Laudis\Neo4j\Bolt;
 
-use Bolt\connection\IConnection;
 use Bolt\error\IgnoredException;
 use Bolt\error\MessageException;
 use Bolt\protocol\V3;
diff --git a/src/Bolt/BoltDriver.php b/src/Bolt/BoltDriver.php
@@ -14,11 +14,11 @@
 namespace Laudis\Neo4j\Bolt;
 
 use Exception;
-use Laudis\Neo4j\Common\SingleThreadedSemaphore;
-use Laudis\Neo4j\Common\SysVSemaphore;
 use function extension_loaded;
 use function is_string;
 use Laudis\Neo4j\Authentication\Authenticate;
+use Laudis\Neo4j\Common\SingleThreadedSemaphore;
+use Laudis\Neo4j\Common\SysVSemaphore;
 use Laudis\Neo4j\Common\Uri;
 use Laudis\Neo4j\Contracts\AuthenticateInterface;
 use Laudis\Neo4j\Contracts\DriverInterface;
diff --git a/src/Bolt/ProtocolFactory.php b/src/Bolt/ProtocolFactory.php
@@ -23,10 +23,6 @@
 class ProtocolFactory
 {
     /**
-     * @param IConnection $connection
-     * @param AuthenticateInterface $auth
-     * @param string $userAgent
-     *
      * @return array{0: V3, 1: array{server: string, connection_id: string, hints: list}}
      */
     public function createProtocol(IConnection $connection, AuthenticateInterface $auth, string $userAgent): array
diff --git a/src/Bolt/Session.php b/src/Bolt/Session.php
@@ -64,7 +64,7 @@ final class Session implements SessionInterface
     private BookmarkHolder $bookmarkHolder;
 
     /**
-     * @param FormatterInterface<ResultFormat>       $formatter
+     * @param FormatterInterface<ResultFormat>   $formatter
      * @param ConnectionPool|Neo4jConnectionPool $pool
      *
      * @psalm-mutation-free
diff --git a/src/Bolt/SocketConnectionFactory.php b/src/Bolt/SocketConnectionFactory.php
@@ -14,8 +14,9 @@
 namespace Laudis\Neo4j\Bolt;
 
 use Bolt\connection\Socket;
+use Laudis\Neo4j\Contracts\BasicConnectionFactoryInterface;
 
-final class SocketConnectionFactory
+final class SocketConnectionFactory implements BasicConnectionFactoryInterface
 {
     private StreamConnectionFactory $factory;
 
diff --git a/src/Bolt/SslConfigurationFactory.php b/src/Bolt/SslConfigurationFactory.php
@@ -2,23 +2,27 @@
 
 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\Bolt;
 
+use function explode;
+use const FILTER_VALIDATE_IP;
+use function filter_var;
 use Laudis\Neo4j\Databags\SslConfiguration;
 use Laudis\Neo4j\Enum\SslMode;
 use Psr\Http\Message\UriInterface;
 
-use function explode;
-use function filter_var;
-
-use const FILTER_VALIDATE_IP;
-
 class SslConfigurationFactory
 {
     /**
-     * @param UriInterface $uri
-     * @param SslConfiguration $config
-     *
      * @return array{0: 's'|'ssc'|'s', 1: array}
      */
     public function create(UriInterface $uri, SslConfiguration $config): array
@@ -39,10 +43,10 @@ public function create(UriInterface $uri, SslConfiguration $config): array
             return [$sslConfig, $this->enableSsl($uri->getHost(), $sslConfig, $config)];
         }
 
-        return [$sslConfig, null];
+        return [$sslConfig, []];
     }
 
-    private function enableSsl(string $host, string $sslConfig, SslConfiguration $config): ?array
+    private function enableSsl(string $host, string $sslConfig, SslConfiguration $config): array
     {
         $options = [
             'verify_peer' => $config->isVerifyPeer(),
@@ -61,6 +65,6 @@ private function enableSsl(string $host, string $sslConfig, SslConfiguration $co
             return $options;
         }
 
-        return null;
+        return [];
     }
 }
diff --git a/src/Bolt/StreamConnectionFactory.php b/src/Bolt/StreamConnectionFactory.php
@@ -13,16 +13,10 @@
 
 namespace Laudis\Neo4j\Bolt;
 
-use Bolt\connection\IConnection;
 use Bolt\connection\StreamSocket;
-use function explode;
-use const FILTER_VALIDATE_IP;
-use function filter_var;
-use Laudis\Neo4j\Databags\SslConfiguration;
-use Laudis\Neo4j\Enum\SslMode;
-use Psr\Http\Message\UriInterface;
+use Laudis\Neo4j\Contracts\BasicConnectionFactoryInterface;
 
-final class StreamConnectionFactory
+final class StreamConnectionFactory implements BasicConnectionFactoryInterface
 {
     public function create(UriConfiguration $config): Connection
     {
diff --git a/src/Bolt/UriConfiguration.php b/src/Bolt/UriConfiguration.php
@@ -2,6 +2,15 @@
 
 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\Bolt;
 
 final class UriConfiguration
diff --git a/src/BoltFactory.php b/src/BoltFactory.php
@@ -19,11 +19,10 @@
 use Laudis\Neo4j\Bolt\BoltConnection;
 use Laudis\Neo4j\Bolt\Connection;
 use Laudis\Neo4j\Bolt\ProtocolFactory;
-use Laudis\Neo4j\Bolt\SocketConnectionFactory;
 use Laudis\Neo4j\Bolt\SslConfigurationFactory;
-use Laudis\Neo4j\Bolt\StreamConnectionFactory;
 use Laudis\Neo4j\Bolt\UriConfiguration;
 use Laudis\Neo4j\Common\ConnectionConfiguration;
+use Laudis\Neo4j\Contracts\BasicConnectionFactoryInterface;
 use Laudis\Neo4j\Contracts\ConnectionFactoryInterface;
 use Laudis\Neo4j\Contracts\ConnectionInterface;
 use Laudis\Neo4j\Databags\ConnectionRequestData;
@@ -39,17 +38,14 @@
  */
 final class BoltFactory implements ConnectionFactoryInterface
 {
-    /** @var SocketConnectionFactory|StreamConnectionFactory */
-    private $connectionFactory;
+    private BasicConnectionFactoryInterface $connectionFactory;
     private ProtocolFactory $protocolFactory;
     private SslConfigurationFactory $sslConfigurationFactory;
 
     /**
-     * @param StreamConnectionFactory|SocketConnectionFactory $connectionFactory
-     *
      * @psalm-external-mutation-free
      */
-    public function __construct($connectionFactory, ProtocolFactory $protocolFactory, SslConfigurationFactory $sslConfigurationFactory)
+    public function __construct(BasicConnectionFactoryInterface $connectionFactory, ProtocolFactory $protocolFactory, SslConfigurationFactory $sslConfigurationFactory)
     {
         $this->connectionFactory = $connectionFactory;
         $this->protocolFactory = $protocolFactory;
diff --git a/src/Common/SingleThreadedSemaphore.php b/src/Common/SingleThreadedSemaphore.php
@@ -13,7 +13,6 @@
 
 use Generator;
 use Laudis\Neo4j\Contracts\SemaphoreInterface;
-
 use function microtime;
 
 class SingleThreadedSemaphore implements SemaphoreInterface
diff --git a/src/Common/SysVSemaphore.php b/src/Common/SysVSemaphore.php
@@ -14,8 +14,8 @@
 use Generator;
 use function hash;
 use Laudis\Neo4j\Contracts\SemaphoreInterface;
-use RuntimeException;
 use function microtime;
+use RuntimeException;
 use function sem_acquire;
 use function sem_get;
 use function sem_release;
diff --git a/src/Contracts/BasicConnectionFactoryInterface.php b/src/Contracts/BasicConnectionFactoryInterface.php
@@ -0,0 +1,22 @@
+<?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\Contracts;
+
+use Laudis\Neo4j\Bolt\Connection;
+use Laudis\Neo4j\Bolt\UriConfiguration;
+
+interface BasicConnectionFactoryInterface
+{
+    public function create(UriConfiguration $config): Connection;
+}
diff --git a/src/Contracts/ConnectionFactoryInterface.php b/src/Contracts/ConnectionFactoryInterface.php
@@ -13,7 +13,6 @@
 
 use Laudis\Neo4j\Databags\ConnectionRequestData;
 use Laudis\Neo4j\Databags\SessionConfiguration;
-use Laudis\Neo4j\Databags\SslConfiguration;
 
 /**
  * @template T
@@ -27,8 +26,6 @@ public function createConnection(ConnectionRequestData $data, SessionConfigurati
 
     /**
      * @param ConnectionInterface<T> $connection
-     *
-     * @return bool
      */
     public function canReuseConnection(ConnectionInterface $connection, ConnectionRequestData $data): bool;
 
diff --git a/src/Neo4j/Neo4jConnectionPool.php b/src/Neo4j/Neo4jConnectionPool.php
@@ -13,8 +13,6 @@
 
 namespace Laudis\Neo4j\Neo4j;
 
-use Generator;
-use Laudis\Neo4j\Contracts\DriverInterface;
 use function array_slice;
 use function array_unique;
 use Bolt\error\MessageException;
@@ -24,22 +22,24 @@
 use Bolt\protocol\V4_4;
 use function count;
 use Exception;
+use Generator;
 use Laudis\Neo4j\Bolt\BoltConnection;
 use Laudis\Neo4j\Bolt\BoltConnectionPool;
 use Laudis\Neo4j\Common\Uri;
 use Laudis\Neo4j\Contracts\AuthenticateInterface;
 use Laudis\Neo4j\Contracts\ConnectionInterface;
 use Laudis\Neo4j\Contracts\ConnectionPoolInterface;
+use Laudis\Neo4j\Contracts\DriverInterface;
 use Laudis\Neo4j\Databags\SessionConfiguration;
 use Laudis\Neo4j\Enum\AccessMode;
 use Laudis\Neo4j\Enum\RoutingRoles;
 use function max;
-use function range;
-use function shuffle;
-use function str_replace;
 use const PHP_INT_MAX;
 use Psr\Http\Message\UriInterface;
 use function random_int;
+use function range;
+use function shuffle;
+use function str_replace;
 use function str_starts_with;
 use function time;
 
diff --git a/tests/Unit/BoltFactoryTest.php b/tests/Unit/BoltFactoryTest.php
@@ -0,0 +1,73 @@
+<?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\Tests\Unit;
+
+use Bolt\connection\IConnection;
+use Bolt\PackStream\v1\Packer;
+use Bolt\PackStream\v1\Unpacker;
+use Bolt\protocol\V4;
+use Laudis\Neo4j\Authentication\Authenticate;
+use Laudis\Neo4j\Bolt\BoltConnection;
+use Laudis\Neo4j\Bolt\Connection;
+use Laudis\Neo4j\Bolt\ProtocolFactory;
+use Laudis\Neo4j\Bolt\SslConfigurationFactory;
+use Laudis\Neo4j\BoltFactory;
+use Laudis\Neo4j\Common\Uri;
+use Laudis\Neo4j\Contracts\AuthenticateInterface;
+use Laudis\Neo4j\Contracts\BasicConnectionFactoryInterface;
+use Laudis\Neo4j\Databags\ConnectionRequestData;
+use Laudis\Neo4j\Databags\SessionConfiguration;
+use Laudis\Neo4j\Databags\SslConfiguration;
+use PHPUnit\Framework\TestCase;
+
+final class BoltFactoryTest extends TestCase
+{
+    private BoltFactory $factory;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $basicConnectionFactory = $this->createMock(BasicConnectionFactoryInterface::class);
+        $basicConnectionFactory->method('create')
+            ->willReturn(new Connection($this->createMock(IConnection::class), ''));
+        $protocolFactory = $this->createMock(ProtocolFactory::class);
+        $protocolFactory->method('createProtocol')
+            ->willReturnCallback(static function (IConnection $connection) {
+                return [
+                    new V4(new Packer(), new Unpacker(), $connection),
+                    ['server' => 'abc', 'connection_id' => 'i'],
+                    ];
+            });
+
+        $this->factory = new BoltFactory(
+            $basicConnectionFactory,
+            $protocolFactory,
+            new SslConfigurationFactory()
+        );
+    }
+
+    public function testCreateBasic(): void
+    {
+        $connection = $this->factory->createConnection(
+            new ConnectionRequestData(Uri::create(''), Authenticate::disabled(), '', SslConfiguration::default()),
+            SessionConfiguration::default()
+        );
+
+        static::assertInstanceOf(BoltConnection::class, $connection);
+        static::assertEquals('', $connection->getEncryptionLevel());
+        static::assertInstanceOf(V4::class, $connection->getImplementation()[0]);
+        static::assertInstanceOf(Connection::class,
+            $connection->getImplementation()[1]);
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ final class Session implements SessionInterface`
`64`	`64`	`private BookmarkHolder $bookmarkHolder;`
`65`	`65`
`66`	`66`	`/**`
`67`		`- * @param FormatterInterface<ResultFormat> $formatter`
	`67`	`+ * @param FormatterInterface<ResultFormat> $formatter`
`68`	`68`	`* @param ConnectionPool\|Neo4jConnectionPool $pool`
`69`	`69`	`*`
`70`	`70`	`* @psalm-mutation-free`
Original file line number	Diff line number	Diff line change
`@@ -14,8 +14,9 @@`
`14`	`14`	`namespace Laudis\Neo4j\Bolt;`
`15`	`15`
`16`	`16`	`use Bolt\connection\Socket;`
	`17`	`+use Laudis\Neo4j\Contracts\BasicConnectionFactoryInterface;`
`17`	`18`
`18`		`-final class SocketConnectionFactory`
	`19`	`+final class SocketConnectionFactory implements BasicConnectionFactoryInterface`
`19`	`20`	`{`
`20`	`21`	`private StreamConnectionFactory $factory;`
`21`	`22`