Detect if an activity lacks the start and end keys

Author: natanfelles

src/Debugger.php

@@ -12,6 +12,7 @@
 use Framework\Helpers\Isolation;
 use InvalidArgumentException;
 use JetBrains\PhpStorm\ArrayShape;
+use LogicException;
 
 /**
  * Class Debugger.
@@ -181,12 +182,18 @@ public function getActivities() : array
         $min = .0;
         $max = .0;
         if ($collected) {
+            foreach($collected as $value) {
+                if (!isset($value['start'])) {
+                    throw new LogicException('An activity does not have the "start" key');
+                }
+                if (!isset($value['end'])) {
+                    throw new LogicException('An activity does not have the "end" key.');
+                }
+            }
             \usort($collected, static function ($c1, $c2) {
                 return $c1['start'] <=> $c2['start'];
             });
-            // @phpstan-ignore-next-line - Allowed to fail because activities must have the "start" key!
             $min = \min(\array_column($collected, 'start'));
-            // @phpstan-ignore-next-line - Allowed to fail because activities must have the "end" key!
             $max = \max(\array_column($collected, 'end'));
             foreach ($collected as &$activity) {
                 $this->addActivityValues($activity, $min, $max);

tests/DebuggerTest.php

@@ -11,6 +11,7 @@
 
 use Framework\Debug\Collection;
 use Framework\Debug\Debugger;
+use LogicException;
 use PHPUnit\Framework\TestCase;
 
 final class DebuggerTest extends TestCase
@@ -216,6 +217,39 @@ public function testActivitiesDivisionByZero() : void
         self::assertStringContainsString('1 activity', $debugbar);
     }
 
+    public function testActivitiesWithoutStartKey() : void
+    {
+        $collector = new CollectorMock();
+        $this->debugger->addCollector($collector, 'Foo');
+        $collector->activities = [
+            [
+                'collector' => 'default',
+                'class' => 'Class name',
+                'description' => 'Collected data 1',
+            ],
+        ];
+        $this->expectException(LogicException::class);
+        $this->expectExceptionMessage('An activity does not have the "start" key');
+        $this->debugger->getActivities();
+    }
+
+    public function testActivitiesWithoutEndKey() : void
+    {
+        $collector = new CollectorMock();
+        $this->debugger->addCollector($collector, 'Foo');
+        $collector->activities = [
+            [
+                'collector' => 'default',
+                'class' => 'Class name',
+                'description' => 'Collected data 1',
+                'start' => \microtime(),
+            ],
+        ];
+        $this->expectException(LogicException::class);
+        $this->expectExceptionMessage('An activity does not have the "end" key');
+        $this->debugger->getActivities();
+    }
+
     public function testOptions() : void
     {
         self::assertEmpty($this->debugger->getOptions());
@@ -269,7 +303,7 @@ public function testInvalidIconPathOption() : void
         $this->debugger->setOption('icon_path', $iconPath);
         try {
             $this->debugger->renderDebugbar();
-        } catch (\LogicException $e) {
+        } catch (LogicException $e) {
             self::assertSame(
                 'Icon not found: ' . $iconPath,
                 $e->getMessage()