feature #223 Migrate from vimeo/psalm to phpstan/phpstan (ajgarlag)

This PR was squashed before being merged into the 1.x-dev branch.

Discussion
----------

Migrate from vimeo/psalm to phpstan/phpstan

Depends on #222

Commits
-------

1980f54 Migrate from vimeo/psalm to phpstan/phpstan

Author: chalasr

.github/workflows/static-analysis.yml

@@ -14,24 +14,25 @@ jobs:
         strategy:
             fail-fast: false
             matrix:
-                doctrine-orm: ['2.14.*', '2.18.*', '3.0.*']
+                php: ['8.4']
+                symfony: ['7.2.*']
                 composer-flags: ['--prefer-stable']
 
+        env:
+          SYMFONY_REQUIRE: ${{ matrix.symfony }}
+
         steps:
             - name: "checkout"
               uses: "actions/checkout@v4"
 
             - name: "build the environment"
-              run: "dev/bin/docker-compose build"
-
-            - name: "require specific Doctrine ORM version"
-              run: "dev/bin/php composer require --ansi ${{ matrix.composer-flags }} doctrine/orm:${{ matrix.doctrine-orm }}"
+              run: "dev/bin/docker-compose build --build-arg PHP_VERSION=${{ matrix.php }} php"
 
             - name: "install dependencies"
               run: "dev/bin/php composer update --ansi ${{ matrix.composer-flags }}"
 
-            - name: "run static analysis"
-              run: "dev/bin/php psalm --shepherd --stats"
+            - name: "run phpstan static analysis"
+              run: "dev/bin/php phpstan --memory-limit=256M --ansi"
 
             - name: clear docker volumes
               if: ${{ always() }}

.psalm.baseline.xml

@@ -59,9 +59,9 @@ RUN su-exec app composer global config --no-interaction allow-plugins.bamarni/co
 RUN su-exec app composer global bin php-cs-fixer require --dev friendsofphp/php-cs-fixer \
     && ln -s /home/app/.composer/vendor/bin/php-cs-fixer /app/bin/php-cs-fixer
 
-# Psalm
-RUN su-exec app composer global bin psalm require --dev vimeo/psalm psalm/plugin-symfony \
-    && ln -s /home/app/.composer/vendor/bin/psalm /app/bin/psalm
+# PHPstan
+RUN su-exec app composer global bin phpstan require --dev phpstan/phpstan phpstan/phpstan-symfony \
+&& ln -s /home/app/.composer/vendor/bin/phpstan /app/bin/phpstan
 
 # Enable parallel package installation for Composer
 RUN su-exec app composer global require symfony/flex

dev/docker/Dockerfile

@@ -0,0 +1,11 @@
+includes:
+    - /home/app/.composer/vendor-bin/phpstan/vendor/phpstan/phpstan-symfony/extension.neon
+    - /home/app/.composer/vendor-bin/phpstan/vendor/phpstan/phpstan-symfony/rules.neon
+
+parameters:
+    level: 8
+    paths:
+        - src/
+    scanFiles:
+      - vendor/symfony/dependency-injection/Loader/Configurator/ContainerConfigurator.php
+    treatPhpDocTypesAsCertain: false

phpstan.dist.neon

@@ -31,11 +31,6 @@ final class GenerateKeyPairCommand extends Command
         'ES512',
     ];
 
-    /**
-     * @deprecated
-     */
-    protected static $defaultName = 'league:oauth2-server:generate-keypair';
-
     private Filesystem $filesystem;
 
     private string $secretKey;
@@ -142,19 +137,19 @@ private function generateKeyPair(?string $passphrase, string $algorithm): array
 
         $resource = openssl_pkey_new($config);
         if (false === $resource) {
-            throw new \RuntimeException(openssl_error_string());
+            throw new \RuntimeException(openssl_error_string() ?: '');
         }
 
         $success = openssl_pkey_export($resource, $privateKey, $passphrase);
 
         if (false === $success) {
-            throw new \RuntimeException(openssl_error_string());
+            throw new \RuntimeException(openssl_error_string() ?: '');
         }
 
         $publicKeyData = openssl_pkey_get_details($resource);
 
         if (!\is_array($publicKeyData)) {
-            throw new \RuntimeException(openssl_error_string());
+            throw new \RuntimeException(openssl_error_string() ?: '');
         }
 
         if (!\array_key_exists('key', $publicKeyData) || !\is_string($publicKeyData['key'])) {
@@ -164,6 +159,9 @@ private function generateKeyPair(?string $passphrase, string $algorithm): array
         return [$privateKey, $publicKeyData['key']];
     }
 
+    /**
+     * @return mixed[]
+     */
     private function buildOpenSSLConfiguration(string $algorithm): array
     {
         $digestAlgorithms = [

psalm.xml

@@ -6,7 +6,7 @@
 
 use League\Bundle\OAuth2ServerBundle\Manager\ClientFilter;
 use League\Bundle\OAuth2ServerBundle\Manager\ClientManagerInterface;
-use League\Bundle\OAuth2ServerBundle\Model\AbstractClient;
+use League\Bundle\OAuth2ServerBundle\Model\ClientInterface;
 use League\Bundle\OAuth2ServerBundle\ValueObject\Grant;
 use League\Bundle\OAuth2ServerBundle\ValueObject\RedirectUri;
 use League\Bundle\OAuth2ServerBundle\ValueObject\Scope;
@@ -100,6 +100,9 @@ private function getFindByCriteria(InputInterface $input): ClientFilter
         ;
     }
 
+    /**
+     * @param array<ClientInterface> $clients
+     */
     private function drawTable(InputInterface $input, OutputInterface $output, array $clients): void
     {
         $io = new SymfonyStyle($input, $output);
@@ -108,9 +111,15 @@ private function drawTable(InputInterface $input, OutputInterface $output, array
         $io->table($columns, $rows);
     }
 
+    /**
+     * @param array<ClientInterface> $clients
+     * @param array<string> $columns
+     *
+     * @return array<array<string>>
+     */
     private function getRows(array $clients, array $columns): array
     {
-        return array_map(static function (AbstractClient $client) use ($columns): array {
+        return array_map(static function (ClientInterface $client) use ($columns): array {
             $values = [
                 'name' => $client->getName(),
                 'identifier' => $client->getIdentifier(),
@@ -126,6 +135,9 @@ private function getRows(array $clients, array $columns): array
         }, $clients);
     }
 
+    /**
+     * @return array<string>
+     */
     private function getColumns(InputInterface $input): array
     {
         $requestedColumns = $input->getOption('columns');

src/Command/GenerateKeyPairCommand.php

@@ -94,22 +94,19 @@ private function getClientActiveFromInput(InputInterface $input, bool $actual):
     }
 
     /**
-     * @template T1 of RedirectUri
-     * @template T2 of Grant
-     * @template T3 of Scope
+     * @template T of RedirectUri|Grant|Scope
      *
-     * @param class-string<T1>|class-string<T2>|class-string<T3> $modelFqcn
+     * @param list<\Stringable> $actual
+     * @param class-string<T> $modelFqcn
      *
-     * @return list<T1>|list<T2>|list<T3>
-     *
-     * @psalm-suppress UnsafeInstantiation
+     * @return list<T>
      */
     private function getClientRelatedModelsFromInput(InputInterface $input, string $modelFqcn, array $actual, string $argument): array
     {
-        /** @var list<string> $toAdd */
+        /** @var list<non-empty-string> $toAdd */
         $toAdd = $input->getOption($addArgument = \sprintf('add-%s', $argument));
 
-        /** @var list<string> $toRemove */
+        /** @var list<non-empty-string> $toRemove */
         $toRemove = $input->getOption($removeArgument = \sprintf('remove-%s', $argument));
 
         if ([] !== $colliding = array_intersect($toAdd, $toRemove)) {
@@ -120,7 +117,7 @@ private function getClientRelatedModelsFromInput(InputInterface $input, string $
             return !\in_array((string) $model, $toRemove);
         });
 
-        /** @var list<T1>|list<T2>|list<T3> */
+        /** @var list<T> */
         return array_merge($filtered, array_map(static function (string $value) use ($modelFqcn) {
             return new $modelFqcn($value);
         }, $toAdd));

src/Command/ListClientsCommand.php

@@ -10,10 +10,6 @@
 
 final class UserConverter implements UserConverterInterface
 {
-    /**
-     * @psalm-suppress ArgumentTypeCoercion
-     * @psalm-suppress UndefinedInterfaceMethod
-     */
     public function toLeague(UserInterface $user): UserEntityInterface
     {
         $userEntity = new User();

src/Command/UpdateClientCommand.php

@@ -22,7 +22,7 @@ public function getName(): string
     }
 
     /**
-     * @param list<string> $values
+     * @param list<non-empty-string> $values
      *
      * @return list<GrantModel>
      */

src/Converter/UserConverter.php

@@ -8,7 +8,7 @@
 use Doctrine\DBAL\Types\TextType;
 
 /**
- * @psalm-template T
+ * @template T
  */
 abstract class ImplodedArray extends TextType
 {
@@ -17,9 +17,6 @@ abstract class ImplodedArray extends TextType
      */
     private const VALUE_DELIMITER = ' ';
 
-    /**
-     * @psalm-suppress MixedArgumentTypeCoercion
-     */
     public function convertToDatabaseValue(mixed $value, AbstractPlatform $platform): ?string
     {
         if (!\is_array($value)) {
@@ -30,7 +27,6 @@ public function convertToDatabaseValue(mixed $value, AbstractPlatform $platform)
             return null;
         }
 
-        /** @psalm-var T $item */
         foreach ($value as $item) {
             $this->assertValueCanBeImploded($item);
         }
@@ -39,7 +35,7 @@ public function convertToDatabaseValue(mixed $value, AbstractPlatform $platform)
     }
 
     /**
-     * @psalm-return list<T>
+     * @return list<T>
      */
     public function convertToPHPValue(mixed $value, AbstractPlatform $platform): array
     {
@@ -68,7 +64,7 @@ public function requiresSQLCommentHint(AbstractPlatform $platform): bool
     }
 
     /**
-     * @psalm-param T $value
+     * @param T $value
      */
     private function assertValueCanBeImploded($value): void
     {

src/DBAL/Type/Grant.php

@@ -22,7 +22,7 @@ public function getName(): string
     }
 
     /**
-     * @param list<string> $values
+     * @param list<non-empty-string> $values
      *
      * @return list<RedirectUriModel>
      */