Merge pull request #8 from flownative/task/cleanup

Code cleanup
flownative · Aug 25, 2022 · e4c6742 · e4c6742
2 parents de2521b + 28a11aa
commit e4c6742
Show file tree

Hide file tree

Showing 22 changed files with 89 additions and 73 deletions.
diff --git a/Classes/Collector/AbstractCollector.php b/Classes/Collector/AbstractCollector.php
@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 namespace Flownative\Prometheus\Collector;
 
 /*
@@ -14,22 +15,22 @@ abstract class AbstractCollector
     /**
      * @var StorageInterface
      */
-    protected $storage;
+    protected StorageInterface $storage;
 
     /**
      * @var string
      */
-    protected $name;
+    protected string $name;
 
     /**
      * @var string
      */
-    protected $help = '';
+    protected string $help = '';
 
     /**
      * @var array
      */
-    protected $labels = [];
+    protected array $labels = [];
 
     /**
      * @param StorageInterface $storage

diff --git a/Classes/Collector/Counter.php b/Classes/Collector/Counter.php
@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 namespace Flownative\Prometheus\Collector;
 
 /*
@@ -23,7 +24,7 @@ public function getType(): string
     }
 
     /**
-     * @param int|float|double $amount
+     * @param int|float $amount
      * @param array $labels
      */
     public function inc($amount = 1, array $labels = []): void

diff --git a/Classes/Collector/Gauge.php b/Classes/Collector/Gauge.php
@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 namespace Flownative\Prometheus\Collector;
 
 /*
@@ -25,7 +26,7 @@ public function getType(): string
     /**
      * Increase the gauge's value
      *
-     * @param int|float|double $amount
+     * @param int|float $amount
      * @param array $labels
      */
     public function inc($amount = 1, array $labels = []): void
@@ -36,7 +37,7 @@ public function inc($amount = 1, array $labels = []): void
     /**
      * Decrease the gauge's value
      *
-     * @param int|float|double $amount
+     * @param int|float $amount
      * @param array $labels
      */
     public function dec($amount = 1, array $labels = []): void
@@ -47,7 +48,7 @@ public function dec($amount = 1, array $labels = []): void
     /**
      * Set the gauge's value
      *
-     * @param int|float|double $value
+     * @param int|float $value
      * @param array $labels
      */
     public function set($value, array $labels = []): void

diff --git a/Classes/CollectorRegistry.php b/Classes/CollectorRegistry.php
@@ -18,17 +18,17 @@ class CollectorRegistry
     /**
      * @var StorageInterface
      */
-    protected $storage;
+    protected StorageInterface $storage;
 
     /**
      * @var array
      */
-    protected $counters = [];
+    protected array $counters = [];
 
     /**
      * @var array
      */
-    protected $gauges = [];
+    protected array $gauges = [];
 
     /**
      * @param StorageInterface $storage
@@ -52,7 +52,7 @@ public function registerMany(array $collectorConfigurations): void
     /**
      * @param string $name
      * @param string $type
-     * @param string|null $help
+     * @param string $help
      * @param array $labels
      * @throws InvalidCollectorTypeException
      */

diff --git a/Classes/Configuration.php b/Classes/Configuration.php
@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 namespace Flownative\Prometheus;
 
 /*
@@ -16,17 +17,17 @@ class Configuration
     /**
      * @var string
      */
-    protected $type;
+    protected string $type;
 
     /**
      * @var string
      */
-    protected $help = '';
+    protected string $help = '';
 
     /**
      * @var array
      */
-    protected $labels = [];
+    protected array $labels = [];
 
     /**
      * @param string $type

diff --git a/Classes/DefaultCollectorRegistry.php b/Classes/DefaultCollectorRegistry.php
@@ -20,7 +20,7 @@ final class DefaultCollectorRegistry extends CollectorRegistry
      * @Flow\InjectConfiguration(path="metrics")
      * @var array
      */
-    protected $settings;
+    protected array $settings = [];
 
     /**
      * @throws Exception\InvalidCollectorTypeException

diff --git a/Classes/Http/MetricsExporterMiddleware.php b/Classes/Http/MetricsExporterMiddleware.php
@@ -28,17 +28,17 @@ class MetricsExporterMiddleware implements MiddlewareInterface
     /**
      * @var CollectorRegistry
      */
-    protected $collectorRegistry;
+    protected CollectorRegistry $collectorRegistry;
 
     /**
-     * @var LoggerInterface
+     * @var LoggerInterface|null
      */
-    protected $logger;
+    protected ?LoggerInterface $logger = null;
 
     /**
      * @var array
      */
-    protected $options = [
+    protected array $options = [
         'telemetryPath' => '/metrics',
         'basicAuth' => []
     ];

diff --git a/Classes/Renderer.php b/Classes/Renderer.php
@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 namespace Flownative\Prometheus;
 
 /*
@@ -41,19 +42,18 @@ public function render(array $sampleCollections): string
             }
             $lines[] = '# TYPE ' . $sampleCollection->getName() . " {$sampleCollection->getType()}";
             foreach ($sampleCollection->getSamples() as $sample) {
-                $lines[] = $this->renderSample($sampleCollection, $sample);
+                $lines[] = $this->renderSample($sample);
             }
             $lines[] = '';
         }
         return trim(implode("\n", $lines));
     }
 
     /**
-     * @param SampleCollection $sampleCollection
      * @param Sample $sample
      * @return string
      */
-    private function renderSample(SampleCollection $sampleCollection, Sample $sample): string
+    private function renderSample(Sample $sample): string
     {
         $labelStatements = [];
         foreach ($sample->getLabels() as $labelName => $labelValue) {

diff --git a/Classes/Sample.php b/Classes/Sample.php
@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 namespace Flownative\Prometheus;
 
 /*
@@ -12,15 +13,15 @@ class Sample
     /**
      * @var string
      */
-    private $name;
+    private string $name;
 
     /**
      * @var array
      */
-    private $labels;
+    private array $labels;
 
     /**
-     * @var int|double
+     * @var int|float
      */
     private $value;
 

diff --git a/Classes/SampleCollection.php b/Classes/SampleCollection.php
@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 namespace Flownative\Prometheus;
 
 /*
@@ -12,27 +13,27 @@ class SampleCollection
     /**
      * @var string
      */
-    private $name;
+    private string $name;
 
     /**
      * @var string
      */
-    private $type;
+    private string $type;
 
     /**
      * @var string
      */
-    private $help;
+    private string $help;
 
     /**
      * @var array
      */
-    private $labels;
+    private array $labels;
 
     /**
      * @var Sample[]
      */
-    private $samples = [];
+    private array $samples;
 
     /**
      * @param string $name

diff --git a/Classes/Storage/CounterUpdate.php b/Classes/Storage/CounterUpdate.php
@@ -15,19 +15,19 @@ class CounterUpdate
      *
      * @var string
      */
-    private $operation;
+    private string $operation;
 
     /**
      * A positive number
      *
-     * @var int|double|float
+     * @var int|float
      */
     private $value;
 
     /**
      * @var array
      */
-    private $labels;
+    private array $labels;
 
     /**
      * @param string $operation
@@ -40,7 +40,7 @@ public function __construct(string $operation, $value, array $labels)
             throw new \InvalidArgumentException(sprintf('counter update: invalid operation type "%s"', $operation), 1573814341);
         }
         if (!is_numeric($value) || $value < 0) {
-            throw new \InvalidArgumentException(sprintf('invalid value for counter update, must be a positive number'), 1573814397);
+            throw new \InvalidArgumentException('invalid value for counter update, must be a positive number', 1573814397);
         }
         $this->operation = $operation;
         $this->value = $value;

diff --git a/Classes/Storage/GaugeUpdate.php b/Classes/Storage/GaugeUpdate.php
@@ -15,19 +15,19 @@ class GaugeUpdate
      *
      * @var string
      */
-    private $operation;
+    private string $operation;
 
     /**
      * A positive number
      *
-     * @var int|double|float
+     * @var int|float
      */
     private $value;
 
     /**
      * @var array
      */
-    private $labels;
+    private array $labels;
 
     /**
      * @param string $operation
@@ -40,7 +40,7 @@ public function __construct(string $operation, $value, array $labels)
             throw new \InvalidArgumentException(sprintf('gauge update: invalid operation type "%s"', $operation), 1574257299);
         }
         if (!is_numeric($value)) {
-            throw new \InvalidArgumentException(sprintf('invalid value for gauge update, must be a number'), 1574257303);
+            throw new \InvalidArgumentException('invalid value for gauge update, must be a number', 1574257303);
         }
         $this->operation = $operation;
         $this->value = $value;

diff --git a/Classes/Storage/InMemoryStorage.php b/Classes/Storage/InMemoryStorage.php
@@ -25,15 +25,16 @@ class InMemoryStorage extends AbstractStorage
     /**
      * @var array
      */
-    private $countersData = [];
+    private array $countersData = [];
 
     /**
      * @var array
      */
-    private $gaugesData = [];
+    private array $gaugesData = [];
 
     /**
      * @return SampleCollection[]
+     * @throws \Exception
      */
     public function collect(): array
     {
@@ -79,6 +80,7 @@ public function registerCollector(AbstractCollector $collector): void
      * @param Counter $counter
      * @param CounterUpdate $update
      * @return void
+     * @throws \Exception
      */
     public function updateCounter(Counter $counter, CounterUpdate $update): void
     {
@@ -102,6 +104,7 @@ public function updateCounter(Counter $counter, CounterUpdate $update): void
      * @param Gauge $gauge
      * @param GaugeUpdate $update
      * @return void
+     * @throws \Exception
      */
     public function updateGauge(Gauge $gauge, GaugeUpdate $update): void
     {
@@ -130,6 +133,7 @@ public function updateGauge(Gauge $gauge, GaugeUpdate $update): void
     /**
      * @param array $collectorsData
      * @return SampleCollection[]
+     * @throws \Exception
      */
     private function prepareCollections(array $collectorsData): array
     {