Support Symfony featues on all Driver Building blocks (#91)

* fix: reworked architecture to support symfony features in every driver building block

* feat: Add events for pre and post: begin, rollback and commit transaction events

---------

Co-authored-by: exaby73 <[email protected]>

Author: transistive

composer.json

@@ -32,6 +32,7 @@
         "symfony/stopwatch": "^6.4",
         "symfony/test-pack": "^1.1",
         "symfony/twig-bundle": "^5.4 || ^6.0 || ^7.0",
+        "symfony/uid": "^6.4",
         "symfony/web-profiler-bundle": "^5.4 || ^6.0 || ^7.0",
         "symfony/yaml": "^5.4 || ^6.0 || ^7.0",
         "vimeo/psalm": "^5.15.0"

config/services.php

@@ -2,24 +2,37 @@
 
 use Laudis\Neo4j\Basic\Driver;
 use Laudis\Neo4j\Basic\Session;
+use Laudis\Neo4j\Common\DriverSetupManager;
 use Laudis\Neo4j\Contracts\ClientInterface;
 use Laudis\Neo4j\Contracts\DriverInterface;
 use Laudis\Neo4j\Contracts\SessionInterface;
 use Laudis\Neo4j\Contracts\TransactionInterface;
-use Neo4j\Neo4jBundle\ClientFactory;
+use Laudis\Neo4j\Databags\DriverConfiguration;
+use Laudis\Neo4j\Databags\SessionConfiguration;
+use Laudis\Neo4j\Databags\TransactionConfiguration;
+use Laudis\Neo4j\Formatter\SummarizedResultFormatter;
+use Neo4j\Neo4jBundle\Builders\ClientBuilder;
+use Neo4j\Neo4jBundle\Decorators\SymfonyClient;
+use Neo4j\Neo4jBundle\EventHandler;
 use Neo4j\Neo4jBundle\EventListener\Neo4jProfileListener;
-use Neo4j\Neo4jBundle\SymfonyClient;
+use Neo4j\Neo4jBundle\Factories\ClientFactory;
+use Neo4j\Neo4jBundle\Factories\StopwatchEventNameFactory;
+use Neo4j\Neo4jBundle\Factories\SymfonyDriverFactory;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
 
 use function Symfony\Component\DependencyInjection\Loader\Configurator\service;
 
 return static function (ContainerConfigurator $configurator) {
     $services = $configurator->services();
 
-    $services->set('neo4j.client_factory', ClientFactory::class)
-        ->args([
-            service('neo4j.event_handler'),
-        ]);
+    $services->set('neo4j.client_factory', ClientFactory::class);
+
+    $services->set(DriverConfiguration::class, DriverConfiguration::class)
+        ->factory([DriverConfiguration::class, 'default']);
+    $services->set(SessionConfiguration::class, SessionConfiguration::class);
+    $services->set(TransactionConfiguration::class, TransactionConfiguration::class);
+    $services->set(ClientBuilder::class, ClientBuilder::class)
+        ->autowire();
 
     $services->set('neo4j.client', SymfonyClient::class)
         ->factory([service('neo4j.client_factory'), 'create'])
@@ -39,6 +52,24 @@
         ->share(false)
         ->public();
 
+    $services->set(SymfonyDriverFactory::class, SymfonyDriverFactory::class)
+        ->arg('$handler', service(EventHandler::class))
+        ->arg('$uuidFactory', service('uuid.factory')->nullOnInvalid());
+
+    $services->set(StopwatchEventNameFactory::class, StopwatchEventNameFactory::class);
+    $services->set(EventHandler::class, EventHandler::class)
+        ->arg('$dispatcher', service('event_dispatcher')->nullOnInvalid())
+        ->arg('$stopwatch', service('debug.stopwatch')->nullOnInvalid())
+        ->arg('$nameFactory', service(StopwatchEventNameFactory::class));
+
+    $services->set(StopwatchEventNameFactory::class);
+
+    $services->set(DriverSetupManager::class, DriverSetupManager::class)
+        ->arg('$formatter', service(SummarizedResultFormatter::class))
+        ->arg('$configuration', service(DriverConfiguration::class));
+    $services->set(SummarizedResultFormatter::class, SummarizedResultFormatter::class)
+        ->factory([SummarizedResultFormatter::class, 'create']);
+
     $services->alias(ClientInterface::class, 'neo4j.client');
     $services->alias(DriverInterface::class, 'neo4j.driver');
     $services->alias(SessionInterface::class, 'neo4j.session');

src/Builders/ClientBuilder.php

@@ -0,0 +1,99 @@
+<?php
+
+namespace Neo4j\Neo4jBundle\Builders;
+
+use Laudis\Neo4j\Authentication\Authenticate;
+use Laudis\Neo4j\Common\DriverSetupManager;
+use Laudis\Neo4j\Common\Uri;
+use Laudis\Neo4j\Contracts\AuthenticateInterface;
+use Laudis\Neo4j\Databags\DriverConfiguration;
+use Laudis\Neo4j\Databags\DriverSetup;
+use Laudis\Neo4j\Databags\SessionConfiguration;
+use Laudis\Neo4j\Databags\TransactionConfiguration;
+use Laudis\Neo4j\Exception\UnsupportedScheme;
+use Neo4j\Neo4jBundle\Decorators\SymfonyClient;
+use Neo4j\Neo4jBundle\Factories\SymfonyDriverFactory;
+
+final class ClientBuilder
+{
+    public const SUPPORTED_SCHEMES = ['', 'bolt', 'bolt+s', 'bolt+ssc', 'neo4j', 'neo4j+s', 'neo4j+ssc', 'http', 'https'];
+
+    /**
+     * @psalm-mutation-free
+     *
+     * @param DriverSetupManager<mixed> $driverSetups
+     */
+    public function __construct(
+        private SessionConfiguration $defaultSessionConfig,
+        private TransactionConfiguration $defaultTransactionConfig,
+        private DriverSetupManager $driverSetups,
+        private readonly SymfonyDriverFactory $driverFactory,
+    ) {
+    }
+
+    public function withDriver(string $alias, string $url, ?AuthenticateInterface $authentication = null, ?int $priority = 0): self
+    {
+        $uri = Uri::create($url);
+
+        $authentication ??= Authenticate::fromUrl($uri, $this->driverSetups->getLogger());
+
+        return $this->withParsedUrl($alias, $uri, $authentication, $priority ?? 0);
+    }
+
+    private function withParsedUrl(string $alias, Uri $uri, AuthenticateInterface $authentication, int $priority): self
+    {
+        $scheme = $uri->getScheme();
+
+        if (!in_array($scheme, self::SUPPORTED_SCHEMES, true)) {
+            throw UnsupportedScheme::make($scheme, self::SUPPORTED_SCHEMES);
+        }
+
+        $tbr = clone $this;
+        $tbr->driverSetups = $this->driverSetups->withSetup(new DriverSetup($uri, $authentication), $alias, $priority);
+
+        return $tbr;
+    }
+
+    public function withDefaultDriver(string $alias): self
+    {
+        $tbr = clone $this;
+        $tbr->driverSetups = $this->driverSetups->withDefault($alias);
+
+        return $tbr;
+    }
+
+    public function build(): SymfonyClient
+    {
+        return new SymfonyClient(
+            driverSetups: $this->driverSetups,
+            defaultSessionConfiguration: $this->defaultSessionConfig,
+            defaultTransactionConfiguration: $this->defaultTransactionConfig,
+            factory: $this->driverFactory
+        );
+    }
+
+    public function withDefaultDriverConfiguration(DriverConfiguration $config): self
+    {
+        $tbr = clone $this;
+
+        $tbr->driverSetups = $tbr->driverSetups->withDriverConfiguration($config);
+
+        return $tbr;
+    }
+
+    public function withDefaultSessionConfiguration(SessionConfiguration $config): self
+    {
+        $tbr = clone $this;
+        $tbr->defaultSessionConfig = $config;
+
+        return $tbr;
+    }
+
+    public function withDefaultTransactionConfiguration(TransactionConfiguration $config): self
+    {
+        $tbr = clone $this;
+        $tbr->defaultTransactionConfig = $config;
+
+        return $tbr;
+    }
+}

src/Collector/Neo4jDataCollector.php

@@ -51,7 +51,7 @@ public function collect(Request $request, Response $response, ?\Throwable $excep
                 'time' => $x['time'],
                 'timestamp' => $x['timestamp'],
                 'result' => [
-                    'statement' => $x['statement']->toArray(),
+                    'statement' => $x['statement']?->toArray(),
                 ],
                 'exception' => [
                     'code' => $x['exception']->getErrors()[0]->getCode(),