refactor: improve type hints and code style across multiple files library up to symfony 7.4.x

.github/workflows/ci.yml

@@ -5,62 +5,55 @@ on: [push]
 jobs:
     cs:
         name: Code Style
-        runs-on: ubuntu-20.04
+        runs-on: ubuntu-latest
         steps:
             - name: Checkout
-              uses: actions/checkout@v2
+              uses: actions/checkout@v4
             - name: Setup PHP
               uses: shivammathur/setup-php@v2
               with:
-                  php-version: 7.4
+                  php-version: 8.2
                   coverage: xdebug
             - name: Get Composer Cache Directory
               id: composer-cache
-              run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+              run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
             - name: Cache dependencies
-              uses: actions/cache@v2
+              uses: actions/cache@v3
               with:
                   path: ${{ steps.composer-cache.outputs.dir }}
                   key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
                   restore-keys: ${{ runner.os }}-composer-
             - name: Install Dependencies
               run: composer install --no-progress
-            - name: Run php-cs-fixture
+            - name: Run php-cs-fixer
               env:
                   PHP_CS_FIXER_FUTURE_MODE: 1
               run: bin/php-cs-fixer fix --config=.php-cs-fixer.php --dry-run --no-interaction --diff
 
     phpunit:
         name: Unit Tests
-        runs-on: ubuntu-20.04
+        runs-on: ubuntu-latest
         env:
             COMPOSER_MEMORY_LIMIT: "-1"
         strategy:
             matrix:
                 include:
-                    # oldest supported versions
-                    - php: 7.2
-                      composer_flags: "--prefer-lowest"
-                      cs_fixer_config: "1.3.*"
-                      symfony_phpunit_remove_return_typehint: 1
-                    - php: 7.3
-                      symfony_version: "4.4.*"
-                    - php: 7.4
-                      symfony_version: "5.1.*"
-                    - php: 7.4
-                      symfony_version: 5.2.*
-                    # most recent versions
-                    - php: 8.0
-                      symfony_version: 5.3.*
-                    - php: 8.0
-                      symfony_version: 5.4.*
-                    - php: 8.0
-                      symfony_version: 6.0.*
                     - php: 8.1
+                      symfony_version: "6.4.*"
+                    - php: 8.2
+                      symfony_version: "6.4.*"
+                    - php: 8.2
+                      symfony_version: "7.0.*"
+                    - php: 8.2
+                      symfony_version: "7.1.*"
+                    - php: 8.3
+                      symfony_version: "7.1.*"
+                    - php: 8.3
+                      symfony_version: "7.2.*"
             fail-fast: false
         steps:
             - name: Checkout
-              uses: actions/checkout@v2
+              uses: actions/checkout@v4
             - name: Setup PHP
               uses: shivammathur/setup-php@v2
               with:
@@ -69,25 +62,19 @@ jobs:
                   coverage: xdebug
             - name: Get Composer Cache Directory
               id: composer-cache
-              run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+              run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
             - name: Cache dependencies
-              uses: actions/cache@v2
+              uses: actions/cache@v3
               with:
                   path: ${{ steps.composer-cache.outputs.dir }}
                   key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
                   restore-keys: ${{ runner.os }}-composer-
             - name: Install Symfony ${{ matrix.symfony_version }}
               run: composer require "symfony/framework-bundle:${{ matrix.symfony_version }}" --no-update
               if: matrix.symfony_version != ''
-            - name: Downgrade php-cs-fixer
-              run: composer require "m6web/php-cs-fixer-config:${{ matrix.cs_fixer_config }}" --no-update
-              if: matrix.cs_fixer_config != ''
             - name: Install Dependencies
-              run: composer update --prefer-dist --no-interaction --optimize-autoloader --prefer-stable --no-progress $COMPOSER_FLAGS
-              env:
-                COMPOSER_FLAGS: ${{ matrix.composer_flags }}
+              run: composer update --prefer-dist --no-interaction --optimize-autoloader --prefer-stable --no-progress
             - name: Run PHPUnit
               run: bin/simple-phpunit
               env:
                   SYMFONY_DEPRECATIONS_HELPER: weak
-                  SYMFONY_PHPUNIT_REMOVE_RETURN_TYPEHINT: ${{ matrix.symfony_phpunit_remove_return_typehint }}

.php-cs-fixer.php

@@ -1,10 +1,16 @@
 <?php
 
-$config = new M6Web\CS\Config\Php71;
+$finder = (new PhpCsFixer\Finder())
+    ->in(__DIR__)
+;
 
-$config->getFinder()
-    ->in([
-        __DIR__
-    ]);
-
-return $config;
+return (new PhpCsFixer\Config())
+    ->setRules([
+        '@PSR12' => true,
+        '@PER-CS' => true,
+        '@PHP81Migration' => true,
+        '@PHPUnit80Migration' => true,
+        'array_syntax' => ['syntax' => 'short'],
+    ])
+    ->setFinder($finder)
+;

Client/ClientInterface.php

@@ -12,7 +12,7 @@ public function __construct(ServerInterface $server);
     /**
      * Send metrics data to the configured server
      *
-     * @param array $lines array of string lines to send
+     * @param array<string> $lines array of string lines to send
      */
     public function sendLines(array $lines): void;
 }

Client/Server.php

@@ -6,8 +6,8 @@
 
 class Server implements ServerInterface
 {
-    /** @var string */
-    private $name;
+    /** @phpstan-ignore property.onlyWritten */
+    private string $name;
 
     /** @var mixed string format udp://.+ */
     private $address;
@@ -18,20 +18,24 @@ class Server implements ServerInterface
     /**
      * Server constructor.
      *
+     * @param array<string, mixed> $serverConfig
+     *
      * @throws ServerException
      */
     public function __construct(string $serverName, array $serverConfig)
     {
         if ($this->checkServersConfigurations($serverName, $serverConfig)) {
             $this->name = $serverName;
             $this->address = $serverConfig['address'];
-            $this->port = intval($serverConfig['port']);
+            $this->port = (int) $serverConfig['port'];
         }
     }
 
     /**
      * Init the servers defined in the app configuration
      *
+     * @param array<string, mixed> $serverConfig
+     *
      * @throws ServerException
      */
     protected function checkServersConfigurations(string $serverName, array $serverConfig): bool
@@ -40,11 +44,11 @@ protected function checkServersConfigurations(string $serverName, array $serverC
             throw new ServerException('No servers have been configured');
         }
 
-        if (!isset($serverConfig['address']) || !isset($serverConfig['port'])) {
-            throw new ServerException($serverName.' : no address or port in the configuration');
+        if (!isset($serverConfig['address'], $serverConfig['port'])) {
+            throw new ServerException($serverName . ' : no address or port in the configuration');
         }
-        if (strpos($serverConfig['address'], 'udp://') !== 0) {
-            throw new ServerException($serverName.' : address should begin with udp://');
+        if (!str_starts_with($serverConfig['address'], 'udp://')) {
+            throw new ServerException($serverName . ' : address should begin with udp://');
         }
 
         return true;

Client/ServerInterface.php

@@ -7,6 +7,8 @@
 interface ServerInterface
 {
     /**
+     * @param array<string, mixed> $serverConfig
+     *
      * @throws ServerException
      */
     public function __construct(string $serverName, array $serverConfig);

Client/UdpClient.php

@@ -7,11 +7,9 @@ class UdpClient implements ClientInterface
     /** @var int max safe size in bytes of one message to send (max official size is 65507) */
     public const MAX_MESSAGE_SIZE = 64000;
 
-    /** @var ServerInterface */
-    protected $server;
+    protected ServerInterface $server;
 
-    /** @var ?bool */
-    protected $debugEnabled;
+    protected ?bool $debugEnabled;
 
     public function __construct(ServerInterface $server, ?bool $debugEnabled = false)
     {
@@ -21,6 +19,8 @@ public function __construct(ServerInterface $server, ?bool $debugEnabled = false
 
     /**
      * Split metrics to send them group by group
+     *
+     * @param array<string> $lines
      */
     public function sendLines(array $lines): void
     {
@@ -30,6 +30,7 @@ public function sendLines(array $lines): void
         }
     }
 
+    /** @param array<string> $lines */
     protected function writeLines(array $lines): bool
     {
         if ($resource = @fsockopen($this->server->getAddress(), $this->server->getPort())) {
@@ -56,7 +57,7 @@ protected function getFormattedLine(string $line): string
     {
         if ($this->debugEnabled) {
             // With debug mode on, we add a carriage return to provide more readable data
-            return $line."\n";
+            return $line . "\n";
         }
 
         return $line;

DataCollector/StatsdDataCollector.php

@@ -36,7 +36,7 @@ public function reset(): void
 
     public function onKernelResponse(ResponseEvent $event): void
     {
-        if (HttpKernelInterface::MASTER_REQUEST === $event->getRequestType()) {
+        if (HttpKernelInterface::MAIN_REQUEST === $event->getRequestType()) {
             foreach ($this->eventListeners as $serviceId => $eventListener) {
                 $clientInfo = [
                     'name' => $serviceId,
@@ -45,14 +45,12 @@ public function onKernelResponse(ResponseEvent $event): void
                 $metricHandler = $eventListener->getMetricHandler();
 
                 foreach ($metricHandler->getMetrics() as $metric) {
-                    if ($metric instanceof MetricInterface) {
-                        try {
-                            $clientInfo['operations'][] = [
-                                'message' => $metricHandler->getFormattedMetric($metric),
-                            ];
-                            $this->data['operations']++;
-                        } catch (MetricException $e) {
-                        }
+                    try {
+                        $clientInfo['operations'][] = [
+                            'message' => $metricHandler->getFormattedMetric($metric),
+                        ];
+                        $this->data['operations']++;
+                    } catch (MetricException $e) {
                     }
                 }
                 $this->data['clients'][] = $clientInfo;
@@ -71,18 +69,16 @@ public function addEventListener(string $serviceId, EventListener $eventListener
     /**
      * Collect the data
      *
-     * @param Request    $request   The request object
-     * @param Response   $response  The response object
-     * @param \Throwable $exception A throwable
+     * @param Request         $request   The request object
+     * @param Response        $response  The response object
+     * @param \Throwable|null $exception A throwable
      */
-    public function collect(Request $request, Response $response, \Throwable $exception = null): void
-    {
-    }
+    public function collect(Request $request, Response $response, ?\Throwable $exception = null): void {}
 
     /**
      * Return the list of statsd operations
      *
-     * @return array operations list
+     * @return array<mixed> operations list
      */
     public function getClients(): array
     {
@@ -104,7 +100,7 @@ public function getOperations(): int
      *
      * @return string data collector name
      */
-    public function getName()
+    public function getName(): string
     {
         return 'statsd';
     }

DependencyInjection/Configuration.php

@@ -48,7 +48,9 @@ private function addServersSection(ArrayNodeDefinition $rootNode): void
                             ->scalarNode('address')
                                 ->isRequired()
                                 ->validate()
-                                    ->ifTrue(function ($v) {return substr($v, 0, 6) !== 'udp://'; })
+                                    ->ifTrue(function ($v) {
+                                        return substr($v, 0, 6) !== 'udp://';
+                                    })
                                     ->thenInvalid("address parameter should begin with 'udp://'")
                                 ->end()
                             ->end()
@@ -187,13 +189,8 @@ private function getClientsGroupsEvents()
         return $eventsNode;
     }
 
-    private function getRootNode(TreeBuilder $treeBuilder, $name)
+    private function getRootNode(TreeBuilder $treeBuilder, string $name): ArrayNodeDefinition
     {
-        // BC layer for symfony/config 4.1 and older
-        if (!\method_exists($treeBuilder, 'getRootNode')) {
-            return $treeBuilder->root($name);
-        }
-
         return $treeBuilder->getRootNode();
     }
 }

DependencyInjection/M6WebStatsdPrometheusExtension.php

@@ -114,7 +114,7 @@ protected function setEventListenerAsServiceAndGetServiceId(string $clientName,
 
     protected function getServiceIdFrom(string $alias): string
     {
-        return ($alias === 'default') ? self::CONFIG_ROOT_KEY : self::CONFIG_ROOT_KEY.$alias;
+        return ($alias === 'default') ? self::CONFIG_ROOT_KEY : self::CONFIG_ROOT_KEY . $alias;
     }
 
     /**
@@ -135,7 +135,7 @@ protected function addEventListenerTagsOnServiceDefinition(Definition $eventList
                         $eventsGroupConfig['tags'] ?? []
                     );
                     // Prefix the metric name.
-                    $metricConfig['name'] = $this->metricsPrefix.$metricConfig['name'];
+                    $metricConfig['name'] = $this->metricsPrefix . $metricConfig['name'];
                 }
                 // Set all the metrics config array in the object
                 // One event can send several metrics. Multiple metrics will be handled in the EventListener.
@@ -245,6 +245,7 @@ protected function getClientServerDefinition(string $clientName, string $serverN
         if (!\array_key_exists($serverName, $this->servers)) {
             throw new InvalidConfigurationException(sprintf('M6WebStatsd client %s used server %s which is not defined in the servers section', $clientName, $serverName));
         }
+
         // Matched server configurations.
         return new Definition(Server::class, [
             $serverName,

Event/AbstractMonitoringEvent.php

@@ -6,13 +6,13 @@
 
 abstract class AbstractMonitoringEvent extends Event implements MonitoringEventInterface
 {
-    /** @var array */
-    protected $parameters;
+    /** @var array<string, mixed> */
+    protected array $parameters;
 
     /**
      * AbstractMonitoringEvent constructor.
      *
-     * @param array $parameters parameters can contain metrics values, tags values or/and custom param values
+     * @param array<string, mixed> $parameters parameters can contain metrics values, tags values or/and custom param values
      *
      * @see https://github.com/M6Web/StatsdPrometheusBundle/blob/master/Doc/usage.md
      */

Event/Console/ConsoleCommandMonitoringEvent.php

@@ -6,7 +6,7 @@
 
 class ConsoleCommandMonitoringEvent extends AbstractMonitoringEvent
 {
-    public static function fromFacade(ConsoleMonitoringEventFacade $facade): ConsoleCommandMonitoringEvent
+    public static function fromFacade(ConsoleMonitoringEventFacade $facade): self
     {
         return new self($facade->toMonitoringArray());
     }

Event/Console/ConsoleErrorMonitoringEvent.php

@@ -6,7 +6,7 @@
 
 class ConsoleErrorMonitoringEvent extends AbstractMonitoringEvent
 {
-    public static function fromFacade(ConsoleMonitoringEventFacade $facade): ConsoleErrorMonitoringEvent
+    public static function fromFacade(ConsoleMonitoringEventFacade $facade): self
     {
         return new self($facade->toMonitoringArray());
     }