Refactor summary data structure (#306)

vjik · web-flow · commit fc978a0beed6 · 2025-06-28T11:20:37.000+05:00
diff --git a/src/Collector/CollectorInterface.php b/src/Collector/CollectorInterface.php
@@ -11,6 +11,7 @@ interface CollectorInterface
 {
     /**
      * @return string Collector's name.
+     * @psalm-return non-empty-string
      */
     public function getName(): string;
 
diff --git a/src/Collector/CollectorTrait.php b/src/Collector/CollectorTrait.php
@@ -4,6 +4,9 @@
 
 namespace Yiisoft\Yii\Debug\Collector;
 
+/**
+ * @psalm-require-implements CollectorInterface
+ */
 trait CollectorTrait
 {
     private bool $isActive = false;
@@ -19,6 +22,9 @@ public function shutdown(): void
         $this->isActive = false;
     }
 
+    /**
+     * @psalm-return non-empty-string
+     */
     public function getName(): string
     {
         return self::class;
diff --git a/src/Collector/Console/CommandCollector.php b/src/Collector/Console/CommandCollector.php
@@ -118,12 +118,10 @@ public function getSummary(): array
         }
 
         return [
-            'command' => [
-                'name' => $commandEvent['name'],
-                'class' => $commandEvent['command'] instanceof Command ? $commandEvent['command']::class : null,
-                'input' => $commandEvent['input'],
-                'exitCode' => $commandEvent['exitCode'] ?? self::UNDEFINED_EXIT_CODE,
-            ],
+            'name' => $commandEvent['name'],
+            'class' => $commandEvent['command'] instanceof Command ? $commandEvent['command']::class : null,
+            'input' => $commandEvent['input'],
+            'exitCode' => $commandEvent['exitCode'] ?? self::UNDEFINED_EXIT_CODE,
         ];
     }
 
diff --git a/src/Collector/Console/ConsoleAppInfoCollector.php b/src/Collector/Console/ConsoleAppInfoCollector.php
@@ -74,17 +74,15 @@ public function getSummary(): array
             return [];
         }
         return [
-            'console' => [
-                'php' => [
-                    'version' => PHP_VERSION,
-                ],
-                'request' => [
-                    'startTime' => $this->requestProcessingTimeStarted,
-                    'processingTime' => $this->requestProcessingTimeStopped - $this->requestProcessingTimeStarted,
-                ],
-                'memory' => [
-                    'peakUsage' => memory_get_peak_usage(),
-                ],
+            'php' => [
+                'version' => PHP_VERSION,
+            ],
+            'request' => [
+                'startTime' => $this->requestProcessingTimeStarted,
+                'processingTime' => $this->requestProcessingTimeStopped - $this->requestProcessingTimeStarted,
+            ],
+            'memory' => [
+                'peakUsage' => memory_get_peak_usage(),
             ],
         ];
     }
diff --git a/src/Collector/EventCollector.php b/src/Collector/EventCollector.php
@@ -8,6 +8,8 @@
 use Yiisoft\Yii\Console\Event\ApplicationStartup as ConsoleApplicationStartup;
 use Yiisoft\Yii\Http\Event\ApplicationStartup as HttpApplicationStartup;
 
+use function count;
+
 final class EventCollector implements SummaryCollectorInterface
 {
     use CollectorTrait;
@@ -53,9 +55,7 @@ public function getSummary(): array
             return [];
         }
         return [
-            'event' => [
-                'total' => count($this->events),
-            ],
+            'total' => count($this->events),
         ];
     }
 
diff --git a/src/Collector/ExceptionCollector.php b/src/Collector/ExceptionCollector.php
@@ -52,14 +52,15 @@ public function getSummary(): array
         if (!$this->isActive()) {
             return [];
         }
+        if ($this->exception === null) {
+            return [];
+        }
         return [
-            'exception' => $this->exception === null ? [] : [
-                'class' => $this->exception::class,
-                'message' => $this->exception->getMessage(),
-                'file' => $this->exception->getFile(),
-                'line' => $this->exception->getLine(),
-                'code' => $this->exception->getCode(),
-            ],
+            'class' => $this->exception::class,
+            'message' => $this->exception->getMessage(),
+            'file' => $this->exception->getFile(),
+            'line' => $this->exception->getLine(),
+            'code' => $this->exception->getCode(),
         ];
     }
 
diff --git a/src/Collector/HttpClientCollector.php b/src/Collector/HttpClientCollector.php
@@ -89,17 +89,15 @@ public function getSummary(): array
             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)
-                        )
+            '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/LogCollector.php b/src/Collector/LogCollector.php
@@ -4,6 +4,8 @@
 
 namespace Yiisoft\Yii\Debug\Collector;
 
+use function count;
+
 class LogCollector implements SummaryCollectorInterface
 {
     use CollectorTrait;
@@ -50,9 +52,7 @@ public function getSummary(): array
             return [];
         }
         return [
-            'logger' => [
-                'total' => count($this->messages),
-            ],
+            'total' => count($this->messages),
         ];
     }
 }
diff --git a/src/Collector/ServiceCollector.php b/src/Collector/ServiceCollector.php
@@ -4,6 +4,8 @@
 
 namespace Yiisoft\Yii\Debug\Collector;
 
+use function count;
+
 final class ServiceCollector implements SummaryCollectorInterface
 {
     use CollectorTrait;
@@ -58,9 +60,7 @@ public function getSummary(): array
             return [];
         }
         return [
-            'service' => [
-                'total' => count($this->items),
-            ],
+            'total' => count($this->items),
         ];
     }
 
diff --git a/src/Collector/Stream/FilesystemStreamCollector.php b/src/Collector/Stream/FilesystemStreamCollector.php
@@ -78,7 +78,7 @@ public function getSummary(): array
             return [];
         }
         return [
-            'fs_stream' => array_merge(
+            'streams' => array_merge(
                 ...array_map(
                     fn (string $operation) => [$operation => count($this->operations[$operation])],
                     array_keys($this->operations)
diff --git a/src/Collector/Stream/HttpStreamCollector.php b/src/Collector/Stream/HttpStreamCollector.php
@@ -87,7 +87,7 @@ public function getSummary(): array
             return [];
         }
         return [
-            'http_stream' => array_merge(
+            'streams' => array_merge(
                 ...array_map(
                     fn (string $operation) => [
                         $operation => count($this->requests[$operation]),
diff --git a/src/Collector/VarDumperCollector.php b/src/Collector/VarDumperCollector.php
@@ -4,6 +4,8 @@
 
 namespace Yiisoft\Yii\Debug\Collector;
 
+use function count;
+
 final class VarDumperCollector implements SummaryCollectorInterface
 {
     use CollectorTrait;
@@ -40,9 +42,7 @@ public function getSummary(): array
         }
 
         return [
-            'var-dumper' => [
-                'total' => count($this->vars),
-            ],
+            'total' => count($this->vars),
         ];
     }
 }
diff --git a/src/Collector/Web/WebAppInfoCollector.php b/src/Collector/Web/WebAppInfoCollector.php
@@ -65,17 +65,15 @@ public function getSummary(): array
             return [];
         }
         return [
-            'web' => [
-                'php' => [
-                    'version' => PHP_VERSION,
-                ],
-                'request' => [
-                    'startTime' => $this->requestProcessingTimeStarted,
-                    'processingTime' => $this->requestProcessingTimeStopped - $this->requestProcessingTimeStarted,
-                ],
-                'memory' => [
-                    'peakUsage' => memory_get_peak_usage(),
-                ],
+            'php' => [
+                'version' => PHP_VERSION,
+            ],
+            'request' => [
+                'startTime' => $this->requestProcessingTimeStarted,
+                'processingTime' => $this->requestProcessingTimeStopped - $this->requestProcessingTimeStarted,
+            ],
+            'memory' => [
+                'peakUsage' => memory_get_peak_usage(),
             ],
         ];
     }
diff --git a/src/Debugger.php b/src/Debugger.php
@@ -15,13 +15,19 @@
 
 /**
  * Debugger collects data from collectors and stores it in a storage.
+ *
+ * @psalm-type TSummary = array{
+ *     id: non-empty-string,
+ *     collectors: list<non-empty-string>,
+ *     summary: array<non-empty-string, array>,
+ * }
  */
 final class Debugger
 {
     /**
      * @var CollectorInterface[] Collectors, indexed by their names.
      *
-     * @psalm-var array<string, CollectorInterface>
+     * @psalm-var array<non-empty-string, CollectorInterface>
      */
     private readonly array $collectors;
 
@@ -31,7 +37,7 @@ final class Debugger
     private readonly DataNormalizer $dataNormalizer;
 
     /**
-     * @var string|null ID of the current request. `null` if debugger is not active.
+     * @var non-empty-string|null ID of the current request. `null` if debugger is not active.
      */
     private ?string $id = null;
 
@@ -83,6 +89,8 @@ public function isActive(): bool
      * Throws `LogicException` if debugger is not started. Use {@see isActive()} to check if debugger is active.
      *
      * @return string ID of the current request.
+     *
+     * @psalm-return non-empty-string
      */
     public function getId(): string
     {
@@ -110,6 +118,7 @@ public function start(object $event): void
             return;
         }
 
+        /** @var non-empty-string */
         $this->id = str_replace('.', '', uniqid('', true));
 
         foreach ($this->collectors as $collector) {
@@ -178,18 +187,25 @@ private function deactivate(): void
     }
 
     /**
-     * Collects summary data of current request.
+     * Collects summary data of current request. Structure of the summary data is:
+     *
+     * - `id` - ID of the current request,
+     * - `collectors` - list of collector names used in the current request,
+     * - `summary` - summary data collected by collectors indexed by collector names.
+     *
+     * @psalm-return TSummary
      */
     private function collectSummaryData(): array
     {
         $summaryData = [
             'id' => $this->getId(),
             'collectors' => array_keys($this->collectors),
+            'summary' => [],
         ];
 
         foreach ($this->collectors as $collector) {
             if ($collector instanceof SummaryCollectorInterface) {
-                $summaryData = [...$summaryData, ...$collector->getSummary()];
+                $summaryData['summary'][$collector->getName()] = $collector->getSummary();
             }
         }
 
diff --git a/src/Storage/StorageInterface.php b/src/Storage/StorageInterface.php
@@ -27,12 +27,12 @@ interface StorageInterface
     /**
      * Read all data from storage
      *
-     * @param string $type type of data being read. Available types:
+     * @param string $type Type of data being read. Available types:
      * - {@see TYPE_SUMMARY}
      * - {@see TYPE_DATA}
      * - {@see TYPE_OBJECTS}
      *
-     * @return array data from storage
+     * @return array Data from storage
      *
      * @psalm-param self::TYPE_* $type
      */
diff --git a/tests/Unit/Collector/CommandCollectorTest.php b/tests/Unit/Collector/CommandCollectorTest.php
@@ -71,10 +71,9 @@ protected function checkCollectedData(array $data): void
 
     protected function checkSummaryData(array $data): void
     {
-        $this->assertArrayHasKey('command', $data);
-        $this->assertArrayHasKey('input', $data['command']);
-        $this->assertArrayHasKey('class', $data['command']);
-        $this->assertEquals('test1', $data['command']['input']);
-        $this->assertEquals(null, $data['command']['class']);
+        $this->assertArrayHasKey('input', $data);
+        $this->assertArrayHasKey('class', $data);
+        $this->assertEquals('test1', $data['input']);
+        $this->assertEquals(null, $data['class']);
     }
 }
diff --git a/tests/Unit/Collector/ConsoleAppInfoCollectorTest.php b/tests/Unit/Collector/ConsoleAppInfoCollectorTest.php
@@ -58,15 +58,14 @@ 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->assertArrayHasKey('php', $data);
+        $this->assertArrayHasKey('version', $data['php']);
+        $this->assertArrayHasKey('request', $data);
+        $this->assertArrayHasKey('startTime', $data['request']);
+        $this->assertArrayHasKey('processingTime', $data['request']);
+        $this->assertArrayHasKey('memory', $data);
+        $this->assertArrayHasKey('peakUsage', $data['memory']);
 
-        $this->assertEquals(PHP_VERSION, $data['console']['php']['version']);
+        $this->assertEquals(PHP_VERSION, $data['php']['version']);
     }
 }
diff --git a/tests/Unit/Collector/ExceptionCollectorTest.php b/tests/Unit/Collector/ExceptionCollectorTest.php
diff --git a/tests/Unit/Collector/FilesystemStreamCollectorTest.php b/tests/Unit/Collector/FilesystemStreamCollectorTest.php
diff --git a/tests/Unit/Collector/HttpClientCollectorTest.php b/tests/Unit/Collector/HttpClientCollectorTest.php
diff --git a/tests/Unit/Collector/HttpStreamCollectorTest.php b/tests/Unit/Collector/HttpStreamCollectorTest.php
diff --git a/tests/Unit/Collector/VarDumperCollectorTest.php b/tests/Unit/Collector/VarDumperCollectorTest.php
diff --git a/tests/Unit/Collector/VarDumperHandlerInterfaceProxyTest.php b/tests/Unit/Collector/VarDumperHandlerInterfaceProxyTest.php

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@ interface CollectorInterface`
`11`	`11`	`{`
`12`	`12`	`/**`
`13`	`13`	`* @return string Collector's name.`
	`14`	`+ * @psalm-return non-empty-string`
`14`	`15`	`*/`
`15`	`16`	`public function getName(): string;`
`16`	`17`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,9 @@`
`4`	`4`
`5`	`5`	`namespace Yiisoft\Yii\Debug\Collector;`
`6`	`6`
	`7`	`+/**`
	`8`	`+ * @psalm-require-implements CollectorInterface`
	`9`	`+ */`
`7`	`10`	`trait CollectorTrait`
`8`	`11`	`{`
`9`	`12`	`private bool $isActive = false;`
`@@ -19,6 +22,9 @@ public function shutdown(): void`
`19`	`22`	`$this->isActive = false;`
`20`	`23`	`}`
`21`	`24`
	`25`	`+ /**`
	`26`	`+ * @psalm-return non-empty-string`
	`27`	`+ */`
`22`	`28`	`public function getName(): string`
`23`	`29`	`{`
`24`	`30`	`return self::class;`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,8 @@`
`8`	`8`	`use Yiisoft\Yii\Console\Event\ApplicationStartup as ConsoleApplicationStartup;`
`9`	`9`	`use Yiisoft\Yii\Http\Event\ApplicationStartup as HttpApplicationStartup;`
`10`	`10`
	`11`	`+use function count;`
	`12`	`+`
`11`	`13`	`final class EventCollector implements SummaryCollectorInterface`
`12`	`14`	`{`
`13`	`15`	`use CollectorTrait;`
`@@ -53,9 +55,7 @@ public function getSummary(): array`
`53`	`55`	`return [];`
`54`	`56`	`}`
`55`	`57`	`return [`
`56`		`- 'event' => [`
`57`		`- 'total' => count($this->events),`
`58`		`- ],`
	`58`	`+ 'total' => count($this->events),`
`59`	`59`	`];`
`60`	`60`	`}`
`61`	`61`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,8 @@`
`4`	`4`
`5`	`5`	`namespace Yiisoft\Yii\Debug\Collector;`
`6`	`6`
	`7`	`+use function count;`
	`8`	`+`
`7`	`9`	`class LogCollector implements SummaryCollectorInterface`
`8`	`10`	`{`
`9`	`11`	`use CollectorTrait;`
`@@ -50,9 +52,7 @@ public function getSummary(): array`
`50`	`52`	`return [];`
`51`	`53`	`}`
`52`	`54`	`return [`
`53`		`- 'logger' => [`
`54`		`- 'total' => count($this->messages),`
`55`		`- ],`
	`55`	`+ 'total' => count($this->messages),`
`56`	`56`	`];`
`57`	`57`	`}`
`58`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,7 @@ public function getSummary(): array`
`78`	`78`	`return [];`
`79`	`79`	`}`
`80`	`80`	`return [`
`81`		`- 'fs_stream' => array_merge(`
	`81`	`+ 'streams' => array_merge(`
`82`	`82`	`...array_map(`
`83`	`83`	`fn (string $operation) => [$operation => count($this->operations[$operation])],`
`84`	`84`	`array_keys($this->operations)`