Add more tests (#227)

* Add more tests * Fix test * Cover BacktraceIgnoreMatcher * Cover VarDumperCollector * Cover ExceptionCollector * Cover HttpClientCollector * Cover HttpClientCollectorProxy * Apply fixes from StyleCI * Fix test * Cover more cases * Cover more cases * Apply fixes from StyleCI * Apply Rector changes (CI) * Add checks * Cover line * Try fix * fix ci * rollback * fix * fix * Cover more lines * Enhance command test * Apply fixes from StyleCI * Apply Rector changes (CI) --------- Co-authored-by: StyleCI Bot <[email protected]> Co-authored-by: xepozz <[email protected]> Co-authored-by: Sergei Predvoditelev <[email protected]>
yiisoft · Oct 14, 2023 · 8d79cc4 · 8d79cc4
1 parent 71ac2a8
commit 8d79cc4
Show file tree

Hide file tree

Showing 28 changed files with 738 additions and 85 deletions.
diff --git a/src/Collector/Console/ConsoleAppInfoCollector.php b/src/Collector/Console/ConsoleAppInfoCollector.php
@@ -43,7 +43,7 @@ public function getCollected(): array
 
     public function collect(object $event): void
     {
-        if (!is_object($event) || !$this->isActive()) {
+        if (!$this->isActive()) {
             return;
         }
 

diff --git a/src/Collector/ExceptionCollector.php b/src/Collector/ExceptionCollector.php
@@ -19,6 +19,9 @@ public function __construct(private TimelineCollector $timelineCollector)
 
     public function getCollected(): array
     {
+        if (!$this->isActive()) {
+            return [];
+        }
         if ($this->exception === null) {
             return [];
         }
@@ -45,6 +48,9 @@ public function collect(ApplicationError $error): void
 
     public function getSummary(): array
     {
+        if (!$this->isActive()) {
+            return [];
+        }
         return [
             'exception' => $this->exception === null ? [] : [
                 'class' => $this->exception::class,

diff --git a/src/Collector/HttpClientCollector.php b/src/Collector/HttpClientCollector.php
@@ -33,29 +33,7 @@ public function __construct(private TimelineCollector $timelineCollector)
     {
     }
 
-    public function getCollected(): array
-    {
-        return array_merge(...array_values($this->requests));
-    }
-
-    public function getSummary(): array
-    {
-        return [
-            'http' => [
-                'count' => array_sum(array_map(static fn (array $requests) => count($requests), $this->requests)),
-                'totalTime' => array_sum(
-                    array_merge(
-                        ...array_map(
-                            static fn (array $entry) => array_column($entry, 'totalTime'),
-                            array_values($this->requests)
-                        )
-                    )
-                ),
-            ],
-        ];
-    }
-
-    public function collect(RequestInterface $request, float|string $startTime, string $line, ?string $uniqueId): void
+    public function collect(RequestInterface $request, float $startTime, string $line, ?string $uniqueId): void
     {
         if (!$this->isActive()) {
             return;
@@ -73,7 +51,7 @@ public function collect(RequestInterface $request, float|string $startTime, stri
         $this->timelineCollector->collect($this, $uniqueId);
     }
 
-    public function collectTotalTime(?ResponseInterface $response, float|string $startTime, ?string $uniqueId): void
+    public function collectTotalTime(?ResponseInterface $response, float $endTime, ?string $uniqueId): void
     {
         if (!$this->isActive()) {
             return;
@@ -88,7 +66,35 @@ public function collectTotalTime(?ResponseInterface $response, float|string $sta
             $entry['responseStatus'] = $response->getStatusCode();
             Message::rewindBody($response);
         }
-        $entry['endTime'] = $startTime;
+        $entry['endTime'] = $endTime;
         $entry['totalTime'] = $entry['endTime'] - $entry['startTime'];
     }
+
+    public function getCollected(): array
+    {
+        if (!$this->isActive()) {
+            return [];
+        }
+        return array_merge(...array_values($this->requests));
+    }
+
+    public function getSummary(): array
+    {
+        if (!$this->isActive()) {
+            return [];
+        }
+        return [
+            'http' => [
+                'count' => array_sum(array_map(static fn (array $requests) => count($requests), $this->requests)),
+                'totalTime' => array_sum(
+                    array_merge(
+                        ...array_map(
+                            static fn (array $entry) => array_column($entry, 'totalTime'),
+                            array_values($this->requests)
+                        )
+                    )
+                ),
+            ],
+        ];
+    }
 }
diff --git a/src/Collector/VarDumperCollector.php b/src/Collector/VarDumperCollector.php
@@ -29,9 +29,7 @@ public function getCollected(): array
             return [];
         }
 
-        return [
-            'var-dumper' => $this->vars,
-        ];
+        return $this->vars;
     }
 
     public function getSummary(): array

diff --git a/src/Collector/Web/WebAppInfoCollector.php b/src/Collector/Web/WebAppInfoCollector.php
@@ -12,8 +12,6 @@
 use Yiisoft\Yii\Http\Event\AfterRequest;
 use Yiisoft\Yii\Http\Event\BeforeRequest;
 
-use function is_object;
-
 final class WebAppInfoCollector implements SummaryCollectorInterface
 {
     use CollectorTrait;
@@ -44,7 +42,7 @@ public function getCollected(): array
 
     public function collect(object $event): void
     {
-        if (!is_object($event) || !$this->isActive()) {
+        if (!$this->isActive()) {
             return;
         }
 

diff --git a/src/Dumper.php b/src/Dumper.php
@@ -97,7 +97,7 @@ private function dumpNested($variable, int $depth, int $objectCollapseLevel): mi
         return $this->dumpNestedInternal($variable, $depth, 0, $objectCollapseLevel);
     }
 
-    private function getObjectProperties($var): array
+    private function getObjectProperties(object $var): array
     {
         if (\__PHP_Incomplete_Class::class !== $var::class && method_exists($var, '__debugInfo')) {
             $var = $var->__debugInfo();
@@ -158,7 +158,6 @@ private function dumpNestedInternal($var, int $depth, int $level, int $objectCol
                         $objectCollapseLevel
                     );
                 }
-
                 break;
             case 'resource':
             case 'resource (closed)':

diff --git a/src/Storage/FileStorage.php b/src/Storage/FileStorage.php
@@ -136,24 +136,25 @@ private function collectSummaryData(): array
      */
     private function gc(): void
     {
-        $summaryFiles = glob($this->path . '/**/**/sumamry.json', GLOB_NOSORT);
-        if ((is_countable($summaryFiles) ? count($summaryFiles) : 0) >= $this->historySize + 1) {
-            uasort($summaryFiles, static fn ($a, $b) => filemtime($b) <=> filemtime($a));
-            $excessFiles = array_slice($summaryFiles, $this->historySize);
-            foreach ($excessFiles as $file) {
-                $path1 = dirname($file);
-                $path2 = dirname($file, 2);
-                $path3 = dirname($file, 3);
-                $resource = substr($path1, strlen($path3));
-
-
-                FileHelper::removeDirectory($this->path . $resource);
-
-                // Clean empty group directories
-                $group = substr($path2, strlen($path3));
-                if (FileHelper::isEmptyDirectory($this->path . $group)) {
-                    FileHelper::removeDirectory($this->path . $group);
-                }
+        $summaryFiles = glob($this->path . '/**/**/summary.json', GLOB_NOSORT);
+        if (empty($summaryFiles) || count($summaryFiles) <= $this->historySize) {
+            return;
+        }
+
+        uasort($summaryFiles, static fn ($a, $b) => filemtime($b) <=> filemtime($a));
+        $excessFiles = array_slice($summaryFiles, $this->historySize);
+        foreach ($excessFiles as $file) {
+            $path1 = dirname($file);
+            $path2 = dirname($file, 2);
+            $path3 = dirname($file, 3);
+            $resource = substr($path1, strlen($path3));
+
+            FileHelper::removeDirectory($this->path . $resource);
+
+            // Clean empty group directories
+            $group = substr($path2, strlen($path3));
+            if (FileHelper::isEmptyDirectory($this->path . $group)) {
+                FileHelper::removeDirectory($this->path . $group);
             }
         }
     }

diff --git a/tests/Shared/AbstractCollectorTestCase.php b/tests/Shared/AbstractCollectorTestCase.php
@@ -40,6 +40,18 @@ public function testEmptyCollector(): void
         }
     }
 
+    public function testInactiveCollector(): void
+    {
+        $collector = $this->getCollector();
+
+        $this->collectTestData($collector);
+
+        $this->assertEquals([], $collector->getCollected());
+        if ($collector instanceof SummaryCollectorInterface) {
+            $this->assertEquals([], $collector->getSummary());
+        }
+    }
+
     abstract protected function getCollector(): CollectorInterface;
 
     abstract protected function collectTestData(CollectorInterface $collector): void;

diff --git a/tests/Support/Application/config/.merge-plan.php b/tests/Support/Application/config/.merge-plan.php
@@ -4,6 +4,8 @@
 
 return [
     '/'=>[
+        'params' => [
 
+        ]
     ],
 ];
diff --git a/tests/Support/Application/config/param1.php b/tests/Support/Application/config/param1.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+    '/' => [
+        'params' => [
+            'yiitest/yii-debug' => [
+                'param1.php',
+            ],
+        ],
+    ],
+];
diff --git a/tests/Support/Stub/ThreeProperties.php b/tests/Support/Stub/ThreeProperties.php
@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Yii\Debug\Tests\Support\Stub;
+
+class ThreeProperties
+{
+    public $first = 'first';
+    protected $second = 'second';
+    private string $third = 'third';
+}
diff --git a/tests/Unit/Collector/.gitignore b/tests/Unit/Collector/.gitignore
diff --git a/tests/Unit/Collector/ConsoleAppInfoCollectorTest.php b/tests/Unit/Collector/ConsoleAppInfoCollectorTest.php
@@ -4,12 +4,17 @@
 
 namespace Yiisoft\Yii\Debug\Tests\Unit\Collector;
 
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Event\ConsoleCommandEvent;
+use Symfony\Component\Console\Event\ConsoleErrorEvent;
+use Symfony\Component\Console\Event\ConsoleTerminateEvent;
+use Symfony\Component\Console\Input\ArrayInput;
+use Symfony\Component\Console\Output\NullOutput;
 use Yiisoft\Yii\Console\Event\ApplicationShutdown;
 use Yiisoft\Yii\Console\Event\ApplicationStartup;
 use Yiisoft\Yii\Debug\Collector\CollectorInterface;
 use Yiisoft\Yii\Debug\Collector\Console\ConsoleAppInfoCollector;
 use Yiisoft\Yii\Debug\Collector\TimelineCollector;
-use Yiisoft\Yii\Debug\Collector\Web\WebAppInfoCollector;
 use Yiisoft\Yii\Debug\Tests\Shared\AbstractCollectorTestCase;
 
 use function sleep;
@@ -18,12 +23,19 @@
 final class ConsoleAppInfoCollectorTest extends AbstractCollectorTestCase
 {
     /**
-     * @param CollectorInterface|WebAppInfoCollector $collector
+     * @param CollectorInterface|ConsoleAppInfoCollector $collector
      */
     protected function collectTestData(CollectorInterface $collector): void
     {
         $collector->collect(new ApplicationStartup(null));
 
+        $command = $this->createMock(Command::class);
+        $input = new ArrayInput([]);
+        $output = new NullOutput();
+        $collector->collect(new ConsoleCommandEvent(null, $input, $output));
+        $collector->collect(new ConsoleErrorEvent($input, $output, new \Exception()));
+        $collector->collect(new ConsoleTerminateEvent($command, $input, $output, 2));
+
         DIRECTORY_SEPARATOR === '\\' ? sleep(1) : usleep(123_000);
 
         $collector->collect(new ApplicationShutdown(0));
@@ -40,4 +52,20 @@ protected function checkCollectedData(array $data): void
 
         $this->assertGreaterThan(0.122, $data['applicationProcessingTime']);
     }
+
+    protected function checkSummaryData(array $data): void
+    {
+        parent::checkSummaryData($data);
+
+        $this->assertArrayHasKey('console', $data);
+        $this->assertArrayHasKey('php', $data['console']);
+        $this->assertArrayHasKey('version', $data['console']['php']);
+        $this->assertArrayHasKey('request', $data['console']);
+        $this->assertArrayHasKey('startTime', $data['console']['request']);
+        $this->assertArrayHasKey('processingTime', $data['console']['request']);
+        $this->assertArrayHasKey('memory', $data['console']);
+        $this->assertArrayHasKey('peakUsage', $data['console']['memory']);
+
+        $this->assertEquals(PHP_VERSION, $data['console']['php']['version']);
+    }
 }
diff --git a/tests/Unit/Collector/ContainerInterfaceProxyTest.php b/tests/Unit/Collector/ContainerInterfaceProxyTest.php
@@ -143,6 +143,10 @@ public function testGetWithoutConfig(): void
 
     public function testGetAndHasWithWrongId(): void
     {
+        $containerProxy = new ContainerInterfaceProxy($this->getContainer(), $this->getConfig());
+
+        $this->assertFalse($containerProxy->has(CollectorInterface::class));
+
         $this->expectException(ContainerExceptionInterface::class);
         $this->expectExceptionMessage(
             sprintf(
@@ -151,11 +155,18 @@ public function testGetAndHasWithWrongId(): void
                 CollectorInterface::class
             )
         );
+        $containerProxy->get(CollectorInterface::class);
+    }
 
+    public function testGetContainerItself(): void
+    {
         $containerProxy = new ContainerInterfaceProxy($this->getContainer(), $this->getConfig());
 
-        $containerProxy->has(CollectorInterface::class);
-        $containerProxy->get(CollectorInterface::class);
+        $this->assertTrue($containerProxy->has(ContainerInterface::class));
+
+        $container = $containerProxy->get(ContainerInterface::class);
+        $this->assertNotNull($container);
+        $this->assertInstanceOf(ContainerInterface::class, $container);
     }
 
     public function testGetAndHasWithNotService(): void

diff --git a/tests/Unit/Collector/EventDispatcherInterfaceProxyTest.php b/tests/Unit/Collector/EventDispatcherInterfaceProxyTest.php
@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Yii\Debug\Tests\Unit\Collector;
+
+use PHPUnit\Framework\TestCase;
+use Psr\EventDispatcher\EventDispatcherInterface;
+use stdClass;
+use Yiisoft\Yii\Debug\Collector\EventCollector;
+use Yiisoft\Yii\Debug\Collector\EventDispatcherInterfaceProxy;
+use Yiisoft\Yii\Debug\Collector\TimelineCollector;
+
+final class EventDispatcherInterfaceProxyTest extends TestCase
+{
+    public function testDispatch()
+    {
+        $event = new stdClass();
+        $collector = new EventCollector(new TimelineCollector());
+        $collector->startup();
+
+        $eventDispatcherMock = $this->createMock(EventDispatcherInterface::class);
+        $eventDispatcherMock
+            ->expects($this->once())
+            ->method('dispatch')
+            ->with($event)
+            ->willReturn($event);
+        $eventDispatcher = new EventDispatcherInterfaceProxy($eventDispatcherMock, $collector);
+
+        $newEvent = $eventDispatcher->dispatch($event);
+
+        $this->assertSame($event, $newEvent);
+        $this->assertCount(1, $collector->getCollected());
+    }
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -43,7 +43,7 @@ public function getCollected(): array @@
         public function collect(object $event): void
         {
-            if (!is_object($event) || !$this->isActive()) {
+            if (!$this->isActive()) {
                 return;
             }
@@ Expand Down @@