From 28a11aa251c7dc27144e1994c584fec28555bd51 Mon Sep 17 00:00:00 2001
From: Karsten Dambekalns <karsten@dambekalns.de>
Date: Wed, 1 Dec 2021 12:06:59 +0100
Subject: [PATCH] Add (strict) typing

---
 Classes/Collector/AbstractCollector.php    |  9 +++++----
 Classes/Collector/Counter.php              |  1 +
 Classes/Collector/Gauge.php                |  1 +
 Classes/CollectorRegistry.php              |  6 +++---
 Classes/Configuration.php                  |  7 ++++---
 Classes/DefaultCollectorRegistry.php       |  2 +-
 Classes/Http/MetricsExporterMiddleware.php |  8 ++++----
 Classes/Renderer.php                       |  1 +
 Classes/Sample.php                         |  5 +++--
 Classes/SampleCollection.php               | 11 ++++++-----
 Classes/Storage/CounterUpdate.php          |  4 ++--
 Classes/Storage/GaugeUpdate.php            |  4 ++--
 Classes/Storage/InMemoryStorage.php        |  4 ++--
 Classes/Storage/RedisStorage.php           | 22 +++++++++++-----------
 Tests/Unit/Http/DummyRequestHandler.php    |  2 +-
 Tests/Unit/Storage/AbstractStorageTest.php |  2 +-
 16 files changed, 48 insertions(+), 41 deletions(-)

diff --git a/Classes/Collector/AbstractCollector.php b/Classes/Collector/AbstractCollector.php
index 25736e2..d55c2c7 100644
--- 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
index 23a8f75..455f37f 100644
--- a/Classes/Collector/Counter.php
+++ b/Classes/Collector/Counter.php
@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 namespace Flownative\Prometheus\Collector;
 
 /*
diff --git a/Classes/Collector/Gauge.php b/Classes/Collector/Gauge.php
index c043df8..656d9b9 100644
--- a/Classes/Collector/Gauge.php
+++ b/Classes/Collector/Gauge.php
@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 namespace Flownative\Prometheus\Collector;
 
 /*
diff --git a/Classes/CollectorRegistry.php b/Classes/CollectorRegistry.php
index 7a15195..83e90ba 100644
--- 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
diff --git a/Classes/Configuration.php b/Classes/Configuration.php
index 7351539..cbdc1b4 100644
--- 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
index 6896718..fc25732 100644
--- 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
index 7e1a2a4..6b47bf3 100644
--- 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
index 11acefb..03d059e 100644
--- a/Classes/Renderer.php
+++ b/Classes/Renderer.php
@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 namespace Flownative\Prometheus;
 
 /*
diff --git a/Classes/Sample.php b/Classes/Sample.php
index 2864964..0c179cd 100644
--- a/Classes/Sample.php
+++ b/Classes/Sample.php
@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 namespace Flownative\Prometheus;
 
 /*
@@ -12,12 +13,12 @@ class Sample
     /**
      * @var string
      */
-    private $name;
+    private string $name;
 
     /**
      * @var array
      */
-    private $labels;
+    private array $labels;
 
     /**
      * @var int|float
diff --git a/Classes/SampleCollection.php b/Classes/SampleCollection.php
index 50560ad..5c2da90 100644
--- 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
index 7440e56..620b0f2 100644
--- a/Classes/Storage/CounterUpdate.php
+++ b/Classes/Storage/CounterUpdate.php
@@ -15,7 +15,7 @@ class CounterUpdate
      *
      * @var string
      */
-    private $operation;
+    private string $operation;
 
     /**
      * A positive number
@@ -27,7 +27,7 @@ class CounterUpdate
     /**
      * @var array
      */
-    private $labels;
+    private array $labels;
 
     /**
      * @param string $operation
diff --git a/Classes/Storage/GaugeUpdate.php b/Classes/Storage/GaugeUpdate.php
index ed2489a..3b6aea0 100644
--- a/Classes/Storage/GaugeUpdate.php
+++ b/Classes/Storage/GaugeUpdate.php
@@ -15,7 +15,7 @@ class GaugeUpdate
      *
      * @var string
      */
-    private $operation;
+    private string $operation;
 
     /**
      * A positive number
@@ -27,7 +27,7 @@ class GaugeUpdate
     /**
      * @var array
      */
-    private $labels;
+    private array $labels;
 
     /**
      * @param string $operation
diff --git a/Classes/Storage/InMemoryStorage.php b/Classes/Storage/InMemoryStorage.php
index 3e09b69..828f7f1 100644
--- a/Classes/Storage/InMemoryStorage.php
+++ b/Classes/Storage/InMemoryStorage.php
@@ -19,12 +19,12 @@ class InMemoryStorage extends AbstractStorage
     /**
      * @var array
      */
-    private $countersData = [];
+    private array $countersData = [];
 
     /**
      * @var array
      */
-    private $gaugesData = [];
+    private array $gaugesData = [];
 
     /**
      * @return SampleCollection[]
diff --git a/Classes/Storage/RedisStorage.php b/Classes/Storage/RedisStorage.php
index 7421751..0211cad 100644
--- a/Classes/Storage/RedisStorage.php
+++ b/Classes/Storage/RedisStorage.php
@@ -31,57 +31,57 @@ class RedisStorage extends AbstractStorage
     /**
      * @var Counter[]
      */
-    protected $counters;
+    protected array $counters = [];
 
     /**
      * @var Gauge[]
      */
-    protected $gauges;
+    protected array $gauges = [];
 
     /**
      * @var Predis\Client
      */
-    protected $redis;
+    protected Predis\Client $redis;
 
     /**
      * @var string
      */
-    protected $hostname = '127.0.0.1';
+    protected string $hostname = '127.0.0.1';
 
     /**
      * @var int
      */
-    protected $port = 6379;
+    protected int $port = 6379;
 
     /**
      * @var array
      */
-    protected $sentinels = [];
+    protected array $sentinels = [];
 
     /**
      * @var string
      */
-    protected $service = 'mymaster';
+    protected string $service = 'mymaster';
 
     /**
      * @var int
      */
-    protected $database = 0;
+    protected int $database = 0;
 
     /**
      * @var string
      */
-    protected $password = '';
+    protected string $password = '';
 
     /**
      * @var string
      */
-    protected $keyPrefix = 'flownative_prometheus';
+    protected string $keyPrefix = 'flownative_prometheus';
 
     /**
      * @var bool
      */
-    protected $ignoreConnectionErrors = false;
+    protected bool $ignoreConnectionErrors = false;
 
     /**
      * @param array $options
diff --git a/Tests/Unit/Http/DummyRequestHandler.php b/Tests/Unit/Http/DummyRequestHandler.php
index 8a6390c..b31f5cd 100644
--- a/Tests/Unit/Http/DummyRequestHandler.php
+++ b/Tests/Unit/Http/DummyRequestHandler.php
@@ -18,7 +18,7 @@ class DummyRequestHandler implements RequestHandlerInterface
     /**
      * @var bool
      */
-    protected $handleCalled = false;
+    protected bool $handleCalled = false;
 
     /**
      * @param ServerRequestInterface $request
diff --git a/Tests/Unit/Storage/AbstractStorageTest.php b/Tests/Unit/Storage/AbstractStorageTest.php
index b548c95..547bf27 100644
--- a/Tests/Unit/Storage/AbstractStorageTest.php
+++ b/Tests/Unit/Storage/AbstractStorageTest.php
@@ -22,7 +22,7 @@ abstract class AbstractStorageTest extends UnitTestCase
     /**
      * @var StorageInterface
      */
-    protected $storage;
+    protected StorageInterface $storage;
 
     /**
      * @test