Added unit test and code coverage over 90 percent

removed the coverage and phunitCoverage.xml

remove unnecessary comments and phpunit.xml

resolved all the psalm errors and info issues

Author: pratikshazalte69

.env

@@ -0,0 +1,9 @@
+DOCKER_HOST_APP_PORT=8000
+DOCKER_HOST_NEO4J_HTTP_PORT=7474
+DOCKER_HOST_NEO4J_BOLT_PORT=7687
+
+NEO4J_HOST=neo4j+s://bb79fe35.databases.neo4j.io
+NEO4J_DATABASE=neo4j
+NEO4J_PORT=7687
+NEO4J_USER=neo4j
+NEO4J_PASSWORD=your_secure_password

.gitignore

@@ -6,3 +6,6 @@ composer.lock
 .php-cs-fixer.cache
 
 composer.origin.json
+
+coverage
+phpunitCoverage.xml

composer.json

@@ -57,6 +57,7 @@
         "psalm": "APP_ENV=dev php bin/console.php cache:warmup && vendor/bin/psalm --show-info=true",
         "fix-cs": "vendor/bin/php-cs-fixer fix",
         "check-cs": "vendor/bin/php-cs-fixer fix --dry-run",
-        "ci-symfony-install-version": "./.github/scripts/setup-symfony-env.bash"
+        "ci-symfony-install-version": "./.github/scripts/setup-symfony-env.bash",
+        "phpunit-with-coverage" : "XDEBUG_MODE=coverage php -d memory_limit=-1 vendor/bin/phpunit --configuration=phpunitCoverage.xml --testsuite=All --coverage-filter=src tests"
     }
 }

docker-compose.yml

@@ -11,11 +11,11 @@ services:
         volumes:
             - ./:/opt/project
         environment:
-            - NEO4J_HOST=neo4j
+            - NEO4J_HOST=${NEO4J_HOST}
             - NEO4J_DATABASE=neo4j
             - NEO4J_PORT=7687
             - NEO4J_USER=neo4j
-            - NEO4J_PASSWORD=testtest
+            - NEO4J_PASSWORD=${NEO4J_PASSWORD}
             - XDEBUG_CONFIG="client_host=host.docker.internal log=/tmp/xdebug.log"
         working_dir: /opt/project
         extra_hosts:

src/Event/FailureEvent.php

@@ -15,53 +15,19 @@ class FailureEvent extends Event
     protected bool $shouldThrowException = true;
 
     public function __construct(
-        private readonly ?string $alias,
-        private readonly ?Statement $statement,
-        private readonly Neo4jException $exception,
-        private readonly \DateTimeInterface $time,
-        private readonly ?string $scheme,
-        private readonly ?string $transactionId,
+        public readonly ?string $alias,
+        public readonly ?Statement $statement,
+        public readonly Neo4jException $exception,
+        public readonly \DateTimeInterface $time,
+        public readonly ?string $scheme,
+        public readonly ?string $transactionId,
     ) {
     }
 
-    public function getStatement(): ?Statement
-    {
-        return $this->statement;
-    }
-
-    public function getException(): Neo4jException
-    {
-        return $this->exception;
-    }
-
     /** @api */
     public function disableException(): void
     {
         $this->shouldThrowException = false;
     }
 
-    public function shouldThrowException(): bool
-    {
-        return $this->shouldThrowException;
-    }
-
-    public function getTime(): \DateTimeInterface
-    {
-        return $this->time;
-    }
-
-    public function getAlias(): ?string
-    {
-        return $this->alias;
-    }
-
-    public function getScheme(): ?string
-    {
-        return $this->scheme;
-    }
-
-    public function getTransactionId(): ?string
-    {
-        return $this->transactionId;
-    }
 }

src/Event/PostRunEvent.php

@@ -12,36 +12,13 @@ class PostRunEvent extends Event
     public const EVENT_ID = 'neo4j.post_run';
 
     public function __construct(
-        private readonly ?string $alias,
-        private readonly ResultSummary $result,
-        private readonly \DateTimeInterface $time,
-        private readonly ?string $scheme,
-        private readonly ?string $transactionId,
+        public readonly ?string $alias,
+        public readonly ResultSummary $result,
+        public readonly \DateTimeInterface $time,
+        public readonly ?string $scheme,
+        public readonly ?string $transactionId
     ) {
     }
 
-    public function getResult(): ResultSummary
-    {
-        return $this->result;
-    }
-
-    public function getTime(): \DateTimeInterface
-    {
-        return $this->time;
-    }
-
-    public function getAlias(): ?string
-    {
-        return $this->alias;
-    }
-
-    public function getScheme(): ?string
-    {
-        return $this->scheme;
-    }
 
-    public function getTransactionId(): ?string
-    {
-        return $this->transactionId;
-    }
 }

src/Event/PreRunEvent.php

@@ -12,37 +12,13 @@ class PreRunEvent extends Event
     public const EVENT_ID = 'neo4j.pre_run';
 
     public function __construct(
-        private readonly ?string $alias,
-        private readonly Statement $statement,
-        private readonly \DateTimeInterface $time,
-        private readonly ?string $scheme,
-        private readonly ?string $transactionId,
+        public readonly ?string $alias,
+        public readonly Statement $statement,
+        public readonly \DateTimeInterface $time,
+        public readonly ?string $scheme,
+        public readonly ?string $transactionId,
     ) {
     }
 
-    /** @api */
-    public function getStatement(): Statement
-    {
-        return $this->statement;
-    }
-
-    public function getTime(): \DateTimeInterface
-    {
-        return $this->time;
-    }
-
-    public function getAlias(): ?string
-    {
-        return $this->alias;
-    }
-
-    public function getScheme(): ?string
-    {
-        return $this->scheme;
-    }
 
-    public function getTransactionId(): ?string
-    {
-        return $this->transactionId;
-    }
 }

src/EventListener/Neo4jProfileListener.php

@@ -12,15 +12,17 @@
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Contracts\Service\ResetInterface;
 
-final class Neo4jProfileListener implements EventSubscriberInterface, ResetInterface
+class Neo4jProfileListener implements EventSubscriberInterface, ResetInterface
 {
     /**
      * @var list<array{
+     *     alias: null|string,
+     *     end_time: float|int,
      *     result: ResultSummary,
-     *     alias: string|null,
-     *     time: string,
      *     start_time: float|int,
-     *     end_time: float|int
+     *     time: string,
+     *     scheme?: null|string,
+     *     transaction_id?: null|string
      * }>
      */
     private array $profiledSummaries = [];
@@ -53,13 +55,16 @@ public static function getSubscribedEvents(): array
 
     public function onPostRun(PostRunEvent $event): void
     {
-        if (in_array($event->getAlias(), $this->enabledProfiles)) {
-            $time = $event->getTime();
-            $result = $event->getResult();
+        if (in_array($event->alias, $this->enabledProfiles)) {
+            $time = $event->time;
+            $result = $event->result;
             $end_time = $time->getTimestamp() + $result->getResultAvailableAfter() + $result->getResultConsumedAfter();
+
             $this->profiledSummaries[] = [
-                'result' => $event->getResult(),
-                'alias' => $event->getAlias(),
+                'result' => $result,
+                'alias' => $event->alias,
+                'scheme' => $event->scheme,
+                'transaction_id' => $event->transactionId,
                 'time' => $time->format('Y-m-d H:i:s'),
                 'start_time' => $time->getTimestamp(),
                 'end_time' => $end_time,
@@ -69,12 +74,12 @@ public function onPostRun(PostRunEvent $event): void
 
     public function onFailure(FailureEvent $event): void
     {
-        if (in_array($event->getAlias(), $this->enabledProfiles)) {
-            $time = $event->getTime();
+        if (in_array($event->alias, $this->enabledProfiles)) {
+            $time = $event->time;
             $this->profiledFailures[] = [
-                'exception' => $event->getException(),
-                'statement' => $event->getStatement(),
-                'alias' => $event->getAlias(),
+                'exception' => $event->exception,
+                'statement' => $event->statement,
+                'alias' => $event->alias,
                 'time' => $time->format('Y-m-d H:i:s'),
                 'timestamp' => $time->getTimestamp(),
             ];

src/Factories/StopwatchEventNameFactory.php

@@ -4,7 +4,7 @@
 
 use Laudis\Neo4j\Enum\TransactionState;
 
-final class StopwatchEventNameFactory
+class StopwatchEventNameFactory
 {
     public function __construct(
     ) {

tests/Unit/Collector/Neo4jDataCollectorTest.php

@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Neo4j\Neo4jBundle\Tests\Unit\Collector;
+use Neo4j\Neo4jBundle\EventListener\Neo4jProfileListener;
+use Neo4j\Neo4jBundle\Collector\Neo4jDataCollector;
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+
+class Neo4jDataCollectorTest extends TestCase
+{
+    private MockObject&Neo4jProfileListener $subscriber;
+    private Neo4jDataCollector $collector;
+
+    protected function setUp(): void
+    {
+        $this->subscriber = $this->createMock(Neo4jProfileListener::class);
+        $this->collector = new Neo4jDataCollector($this->subscriber);
+    }
+
+    public function testGetName(): void
+    {
+        $this->assertSame('neo4j', $this->collector->getName());
+    }
+
+    public function testGetQueryCount(): void
+    {
+        $this->subscriber
+            ->expects($this->once())
+            ->method('getProfiledSummaries')
+            ->willReturn([
+                ['start_time' => 1000, 'query' => 'MATCH (n) RETURN n'],
+            ]);
+
+        $this->collector->collect(new Request(), new Response());
+
+        $this->assertSame(1, $this->collector->getQueryCount());
+    }
+
+    public function testRecursiveToArray(): void
+    {
+        $obj = new class {
+            public function toArray(): array
+            {
+                return ['key' => 'value'];
+            }
+        };
+        $reflection = new \ReflectionClass($this->collector);
+        $method = $reflection->getMethod('recursiveToArray');
+
+        $result = $method->invoke($this->collector, $obj);
+        $this->assertSame(['key' => 'value'], $result);
+    }
+}