implemented proper profiling per driver

Author: transistive

src/Collector/Neo4jDataCollector.php

@@ -4,66 +4,49 @@
 
 namespace Neo4j\Neo4jBundle\Collector;
 
+use Laudis\Neo4j\Databags\ResultSummary;
+use Neo4j\Neo4jBundle\EventSubscriber\ProfileSubscriber;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\DataCollector\DataCollector;
 use Throwable;
 
-/**
- * @author Xavier Coureau <[email protected]>
- */
 final class Neo4jDataCollector extends DataCollector
 {
     public function __construct(
-        private QueryLogger $queryLogger
+        private ProfileSubscriber $subscriber
     ) {}
 
     public function collect(Request $request, Response $response, Throwable $exception = null): void
     {
-        $this->data['time'] = $this->queryLogger->getElapsedTime();
-        $this->data['nb_queries'] = count($this->queryLogger);
-        $this->data['statements'] = $this->queryLogger->getStatements();
-        $this->data['failed_statements'] = array_filter($this->queryLogger->getStatements(), static function ($statement) {
-            return empty($statement['success']);
-        });
-    }
-
-    public function reset(): void
-    {
-        $this->data = [];
-        $this->queryLogger->reset();
-    }
-
-    public function getQueryCount(): int
-    {
-        return $this->data['nb_queries'];
-    }
+        $this->data['successful_statements'] = array_map(
+            static fn (ResultSummary $summary) => $summary->toArray(),
+            $this->subscriber->getProfiledSummaries()
+        );
 
-    /**
-     * Return all statements, successful and not successful.
-     */
-    public function getStatements(): array
-    {
-        return $this->data['statements'];
-    }
+        $this->data['failed_statements'] = array_map(
+            static fn (array $x) => [
+                'statement' => $x['statement']->toArray(),
+                'exception' => [
+                    'code' => $x['exception']->getErrors()[0]->getCode(),
+                    'message' => $x['exception']->getErrors()[0]->getMessage(),
+                    'classification' => $x['exception']->getErrors()[0]->getClassification(),
+                    'category' => $x['exception']->getErrors()[0]->getCategory(),
+                    'title' => $x['exception']->getErrors()[0]->getTitle(),
+                ],
+                'alias' => $x['alias']
 
-    /**
-     * Return not successful statements.
-     */
-    public function getFailedStatements(): array
-    {
-        return $this->data['failed_statements'];
+            ],
+            $this->subscriber->getProfiledFailures()
+        );
     }
 
-    public function getTime(): float
+    public function reset(): void
     {
-        return $this->data['time'];
+        $this->data = [];
+        $this->subscriber->reset();
     }
 
-    public function getTimeForQuery(): float
-    {
-        return $this->data['time'];
-    }
 
     public function getName(): string
     {

src/Collector/QueryLogger.php

@@ -20,6 +20,7 @@
  *     verify_peer?: bool|null,
  * }
  * @psalm-type DriverConfigArray = array{
+ *     profiling?: bool,
  *     acquire_connection_timeout?: int|null,
  *     user_agent?: string|null,
  *     pool_size?: int|null,
@@ -78,6 +79,10 @@ public function getConfigTreeBuilder(): TreeBuilder
                             ->info('The alias for this driver. Default is "default".')
                             ->defaultValue('default')
                         ->end()
+                        ->scalarNode('profiling')
+                            ->info('Enable profiling for requests on this driver')
+                            ->defaultValue('false')
+                        ->end()
                         ->scalarNode('dsn')
                             ->info('The DSN for the driver. Default is "bolt://localhost:7687".')
                             ->defaultValue('bolt://localhost:7687')

src/DependencyInjection/Configuration.php

@@ -4,11 +4,17 @@
 
 namespace Neo4j\Neo4jBundle;
 
+use Laudis\Neo4j\Common\Uri;
+use Laudis\Neo4j\Databags\DatabaseInfo;
+use Laudis\Neo4j\Databags\ResultSummary;
+use Laudis\Neo4j\Databags\ServerInfo;
 use Laudis\Neo4j\Databags\Statement;
 use Laudis\Neo4j\Databags\SummarizedResult;
+use Laudis\Neo4j\Databags\SummaryCounters;
+use Laudis\Neo4j\Enum\ConnectionProtocol;
+use Laudis\Neo4j\Enum\QueryTypeEnum;
 use Laudis\Neo4j\Exception\Neo4jException;
 use Laudis\Neo4j\Types\CypherList;
-use Laudis\Neo4j\Types\CypherMap;
 use Neo4j\Neo4jBundle\Events\FailureEvent;
 use Neo4j\Neo4jBundle\Events\PostRunEvent;
 use Neo4j\Neo4jBundle\Events\PreRunEvent;
@@ -24,31 +30,48 @@ public function __construct(?EventDispatcherInterface $dispatcher)
     }
 
     /**
-     * @param callable():CypherList<SummarizedResult<CypherMap>> $runHandler
-     * @param iterable<Statement>                                $statements
+     * @template T
      *
-     * @return CypherList<SummarizedResult<CypherMap>>
+     * @param callable(Statement):SummarizedResult<T> $runHandler
+     * @param iterable<Statement>                     $statements
+     *
+     * @return SummarizedResult<T>
      */
-    public function handle(callable $runHandler, iterable $statements): CypherList
+    public function handle(callable $runHandler, Statement $statement, string|null $alias): SummarizedResult
     {
         if (null === $this->dispatcher) {
-            return $runHandler();
+            return $runHandler($statement);
         }
 
-        $this->dispatcher->dispatch(new PreRunEvent($statements), PreRunEvent::EVENT_ID);
+        $this->dispatcher->dispatch(new PreRunEvent($alias, $statement), PreRunEvent::EVENT_ID);
 
         try {
-            $tbr = $runHandler();
-            $this->dispatcher->dispatch(new PostRunEvent($tbr), PostRunEvent::EVENT_ID);
+            $tbr = $runHandler($statement);
+            $this->dispatcher->dispatch(new PostRunEvent($alias, $tbr->getSummary()), PostRunEvent::EVENT_ID);
         } catch (Neo4jException $e) {
-            $event = new FailureEvent($e);
+            $event = new FailureEvent($alias, $statement, $e);
             $event = $this->dispatcher->dispatch($event, FailureEvent::EVENT_ID);
 
             if ($event->shouldThrowException()) {
                 throw $e;
             }
+
+            $summary = new ResultSummary(
+                new SummaryCounters(),
+                new DatabaseInfo('n/a'),
+                new CypherList([]),
+                null,
+                null,
+                $statement,
+                QueryTypeEnum::READ_ONLY(),
+                0,
+                0,
+                new ServerInfo(Uri::create(''), ConnectionProtocol::BOLT_V5(), 'n/a'),
+            );
+
+            $tbr = new SummarizedResult($summary);
         }
 
-        return new CypherList();
+        return $tbr;
     }
 }