Add PHPStan, improve CI workflow (#39)

.github/workflows/php.yml

@@ -7,41 +7,65 @@ on:
 
 jobs:
   build:
+    name: PHP ${{ matrix.php-version }} Sf ${{ matrix.symfony-version }}
+    runs-on: ubuntu-latest
+
     strategy:
       matrix:
-        php-version:
-          - '8.2'
-          - '8.3'
-        platform: [ubuntu-latest]
-    name: PHP ${{ matrix.php-version }}
-    runs-on: ubuntu-latest
+        include:
+          - php-version: 8.2
+            symfony-version: 5.4.*
+          - php-version: 8.3
+            symfony-version: 5.4.*
+          - php-version: 8.2
+            symfony-version: 6.4.*
+          - php-version: 8.3
+            symfony-version: 6.4.*
+          - php-version: 8.4
+            symfony-version: 6.4.*
+          - php-version: 8.2
+            symfony-version: 7.2.*
+          - php-version: 8.3
+            symfony-version: 7.2.*
+          - php-version: 8.4
+            symfony-version: 7.2.*
+
     steps:
-      - uses: actions/checkout@v2
-      - uses: nanasess/setup-php@master
+      - name: "Checkout"
+        uses: actions/checkout@v4
+
+      - name: "Setup PHP"
+        uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php-version }}
+          tools: composer:v2
 
       - name: Validate composer.json
         run: composer validate
 
       - name: Cache Composer packages
         id: composer-cache
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: vendor
-          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}-${{ matrix.php-version }}
+          key: composer-${{ runner.os }}-${{ matrix.php-version }}-${{ hashFiles('**/composer.json') }}-${{ matrix.symfony-version }}
           restore-keys: |
-            ${{ runner.os }}-composer-
+            composer-${{ runner.os }}-${{ matrix.php-version }}-
 
       - name: Install dependencies
-        if: steps.composer-cache.outputs.cache-hit != 'true'
-        run: composer install --prefer-dist --no-progress --no-suggest --no-ansi --no-interaction --no-scripts
+        env:
+          SYMFONY_REQUIRE: ${{ matrix.symfony-version }}
+        if: steps.composer-cache.outputs.cache-hit != 'true'  
+        run: composer update --prefer-dist --no-progress --no-ansi --no-interaction --no-scripts
+
+      - name: Run unit tests
+        run: vendor/bin/phpunit
 
       - name: Run style tests
         run: vendor/bin/ecs check -vv
 
-      - name: Run static analyse tests
-        run: vendor/bin/psalm --php-version=${{ matrix.php-version }}
+      - name: Run static analyse phpstan
+        run: vendor/bin/phpstan analyse --error-format=github
 
-      - name: Run unit tests
-        run: vendor/bin/phpunit
+      - name: Run static analyse psalm
+        run: vendor/bin/psalm --php-version=${{ matrix.php-version }}

README.md

@@ -55,6 +55,7 @@ framework:
 ```
 
 ### Step 3: Configure Symfony Messenger
+
 ```yaml
 # config/packages/messenger.yaml
 
@@ -129,6 +130,7 @@ petit_press_gps_messenger:
   Can be very useful when used together with [subscription filters](https://cloud.google.com/pubsub/docs/subscription-message-filter).
 
 ### Step 6: Create topics from config
+
 ```bash
 bin/console messenger:setup-transports
 ```

composer.json

@@ -32,9 +32,14 @@
     },
     "require-dev": {
         "phpunit/phpunit": "^9.5",
-        "vimeo/psalm": "^5.0",
+        "vimeo/psalm": "^6.0",
         "symfony/yaml": "^5.4|^6.0|^7.0",
-        "symplify/easy-coding-standard": "^11.1"
+        "symplify/easy-coding-standard": "^11.1",
+        "phpstan/phpstan": "^2.1",
+        "phpstan/phpstan-symfony": "^2.0",
+        "phpstan/phpstan-deprecation-rules": "^2.0",
+        "phpstan/phpstan-phpunit": "^2.0",
+        "phpstan/phpstan-strict-rules": "^2.0"
     },
     "autoload": {
         "psr-4": { "PetitPress\\GpsMessengerBundle\\": "src" }

phpstan.neon.dist

@@ -0,0 +1,11 @@
+includes:
+    - vendor/phpstan/phpstan-deprecation-rules/rules.neon
+    - vendor/phpstan/phpstan-phpunit/extension.neon
+    - vendor/phpstan/phpstan-strict-rules/rules.neon
+    - vendor/phpstan/phpstan-symfony/extension.neon
+
+parameters:
+    paths:
+        - src
+        - tests
+    level: 9

src/Transport/GpsConfiguration.php

@@ -13,11 +13,33 @@ final class GpsConfiguration implements GpsConfigurationInterface
     private bool   $topicCreationEnabled;
     private string $subscriptionName;
     private bool   $subscriptionCreationEnabled;
+
+    /**
+     * @var array<string, mixed>
+     */
     private array  $clientConfig;
+
+    /**
+     * @var array<string, mixed>
+     */
     private array  $topicOptions;
+
+    /**
+     * @var array<string, mixed>
+     */
     private array  $subscriptionOptions;
+
+    /**
+     * @var array<string, mixed>
+     */
     private array  $subscriptionPullOptions;
 
+    /**
+     * @param array<string, mixed>  $clientConfig
+     * @param array<string, mixed>  $topicOptions
+     * @param array<string, mixed>  $subscriptionOptions
+     * @param array<string, mixed>  $subscriptionPullOptions
+     */
     public function __construct(
         string $topicName,
         bool $topicCreationEnabled,

src/Transport/GpsConfigurationInterface.php

@@ -23,21 +23,25 @@ public function isSubscriptionCreationEnabled(): bool;
 
     /**
      * @see PubSubClient constructor options
+     * @return array<string, mixed>
      */
     public function getClientConfig(): array;
 
     /**
      * @see Topic::create options
+     * @return array<string, mixed>
      */
     public function getTopicOptions(): array;
 
     /**
      * @see Subscription::create options
+     * @return array<string, mixed>
      */
     public function getSubscriptionOptions(): array;
 
     /**
      * @see Subscription::pull options
+     * @return array<string, mixed>
      */
     public function getSubscriptionPullOptions(): array;
 }

src/Transport/GpsConfigurationResolver.php

@@ -118,18 +118,26 @@ function (OptionsResolver $pullResolver): void {
         );
     }
 
+    /**
+     * @param array<string, mixed>  $options
+     *
+     * @return array<int|string, mixed>
+     */
     private function getMergedOptions(string $dsn, array $options): array
     {
         $dnsOptions = [];
         $parsedDnsOptions = parse_url($dsn);
 
         $dsnQueryOptions = $parsedDnsOptions['query'] ?? null;
-        if ($dsnQueryOptions) {
+        if ($dsnQueryOptions !== null && $dsnQueryOptions !== '') {
             parse_str($dsnQueryOptions, $dnsOptions);
         }
 
         $dnsPathOption = $parsedDnsOptions['path'] ?? null;
-        if ($dnsPathOption) {
+        if ($dnsPathOption !== null && $dnsPathOption !== '') {
+            if (! isset($dnsOptions['topic']) || ! is_array($dnsOptions['topic'])) {
+                $dnsOptions['topic'] = [];
+            }
             $dnsOptions['topic']['name'] = substr($dnsPathOption, 1);
         }
 

src/Transport/GpsConfigurationResolverInterface.php

@@ -9,5 +9,8 @@ interface GpsConfigurationResolverInterface
     public const DEFAULT_TOPIC_NAME = 'messages';
     public const DEFAULT_MAX_MESSAGES_PULL = 10;
 
+    /**
+     * @param array<string, mixed> $options
+     */
     public function resolve(string $dsn, array $options): GpsConfigurationInterface;
 }

src/Transport/GpsReceiver.php

@@ -111,6 +111,7 @@ private function getGpsReceivedStamp(Envelope $envelope): GpsReceivedStamp
     private function createEnvelopeFromPubSubMessage(Message $message): Envelope
     {
         try {
+            /** @var array<string, mixed> $rawData */
             $rawData = json_decode($message->data(), true, 512, JSON_THROW_ON_ERROR);
         } catch (JsonException $exception) {
             throw new MessageDecodingFailedException($exception->getMessage(), 0, $exception);

src/Transport/GpsTransportFactory.php

@@ -31,14 +31,19 @@ public function __construct(
     }
 
     /**
-     * {@inheritdoc}
+     * @param array<mixed> $options
+     *
+     * @return GpsTransport
      */
     public function createTransport(string $dsn, array $options, SerializerInterface $serializer): TransportInterface
     {
         $options = $this->gpsConfigurationResolver->resolve($dsn, $options);
 
         $clientConfig = $options->getClientConfig();
         if ($this->cache instanceof CacheItemPoolInterface) {
+            if (! is_array($clientConfig['credentialsConfig'])) {
+                $clientConfig['credentialsConfig'] = [];
+            }
             $clientConfig['credentialsConfig']['authCache'] ??= $this->cache;
         }
         if (isset($this->forcedTransport)) {
@@ -53,7 +58,7 @@ public function createTransport(string $dsn, array $options, SerializerInterface
     }
 
     /**
-     * {@inheritdoc}
+     * @param array<mixed> $options
      */
     public function supports(string $dsn, array $options): bool
     {

tests/DependencyInjection/PetitPressGpsMessengerExtensionTest.php

@@ -27,11 +27,11 @@ public function testSimpleConfiguration(): void
         $config = $this->getSimpleConfig();
         $loader->load([$config], $this->configuration);
 
-        $this->assertTrue($this->configuration->hasDefinition(GpsTransportFactory::class));
+        static::assertTrue($this->configuration->hasDefinition(GpsTransportFactory::class));
         $gpsTransportFactoryDefinition = $this->configuration->getDefinition(GpsTransportFactory::class);
         $cacheArgument = $gpsTransportFactoryDefinition->getArgument(1);
-        $this->assertInstanceOf(Reference::class, $cacheArgument);
-        $this->assertEquals('cache.app', (string) $cacheArgument);
+        static::assertInstanceOf(Reference::class, $cacheArgument);
+        static::assertEquals('cache.app', (string) $cacheArgument);
     }
 
     /**
@@ -50,22 +50,22 @@ public function testFullConfiguration(): void
         $config = $this->getFullConfig();
         $loader->load([$config], $this->configuration);
 
-        $this->assertTrue($this->configuration->hasDefinition(GpsTransportFactory::class));
+        static::assertTrue($this->configuration->hasDefinition(GpsTransportFactory::class));
         $gpsTransportFactoryDefinition = $this->configuration->getDefinition(GpsTransportFactory::class);
         $cacheArgument = $gpsTransportFactoryDefinition->getArgument(1);
-        $this->assertInstanceOf(Reference::class, $cacheArgument);
-        $this->assertEquals('foo', (string) $cacheArgument);
+        static::assertInstanceOf(Reference::class, $cacheArgument);
+        static::assertEquals('foo', (string) $cacheArgument);
     }
 
     /**
-     * @return mixed
+     * @return array<string, mixed>
      */
-    private function getFullConfig()
+    private function getFullConfig(): array
     {
         $yaml = <<<EOF
 auth_cache: 'foo'
 EOF;
-
+        /** @var array<string, mixed> */
         return (new Parser())->parse($yaml);
     }
 
@@ -77,9 +77,9 @@ public function testConfigurationWithDisabledAuthCache(): void
         $config = $this->getDisabledCacheConfig();
         $loader->load([$config], $this->configuration);
 
-        $this->assertTrue($this->configuration->hasDefinition(GpsTransportFactory::class));
+        static::assertTrue($this->configuration->hasDefinition(GpsTransportFactory::class));
         $gpsTransportFactoryDefinition = $this->configuration->getDefinition(GpsTransportFactory::class);
-        $this->assertNull($gpsTransportFactoryDefinition->getArgument(1));
+        static::assertNull($gpsTransportFactoryDefinition->getArgument(1));
     }
 
     /**

tests/Transport/GpsConfigurationTest.php

@@ -24,13 +24,17 @@ protected function setUp(): void
 
     /**
      * @dataProvider dataProvider
+     * @param array<string, mixed>                     $options
      */
     public function testResolve(string $dsn, array $options, GpsConfigurationInterface $expectedConfiguration): void
     {
         $configuration = $this->gpsConfigurationResolver->resolve($dsn, $options);
-        $this->assertEquals($expectedConfiguration, $configuration);
+        static::assertEquals($expectedConfiguration, $configuration);
     }
 
+    /**
+     * @return array<string, mixed>
+     */
     public static function dataProvider(): array
     {
         return [

tests/Transport/GpsReceiverTest.php

@@ -60,19 +60,19 @@ public function testItRejects(): void
         $gpsMessage = new Message(['data' => '']);
 
         $this->gpsConfigurationMock
-            ->expects($this->once())
+            ->expects(static::once())
             ->method('getSubscriptionName')
             ->willReturn(self::SUBSCRIPTION_NAME)
         ;
 
         $this->subscriptionMock
-            ->expects($this->once())
+            ->expects(static::once())
             ->method('modifyAckDeadline')
             ->with($gpsMessage, 0)
         ;
 
         $this->pubSubClientMock
-            ->expects($this->once())
+            ->expects(static::once())
             ->method('subscription')
             ->with(self::SUBSCRIPTION_NAME)
             ->willReturn($this->subscriptionMock)