Merge pull request #868 from greg0ire/drop-psalm

Drop Psalm in favor of PHPStan
doctrine · Dec 10, 2024 · 70326ba · 70326ba
2 parents 33a9d71 + 7cadc10
commit 70326ba
Show file tree

Hide file tree

Showing 15 changed files with 853 additions and 109 deletions.
diff --git a/.github/workflows/static-analysis.yml b/.github/workflows/static-analysis.yml
@@ -4,33 +4,15 @@ on:
   pull_request:
     branches:
       - "*.x"
+    paths:
+      - .github/workflows/static-analysis.yml
+      - composer.*
+      - config/**
+      - src/**
+      - phpstan*
+      - tests/StaticAnalysis/**
   push:
 
 jobs:
-  static-analysis-psalm:
-    name: "Static Analysis with Psalm"
-    runs-on: "ubuntu-20.04"
-
-    strategy:
-      matrix:
-        php-version:
-          - "8.2"
-
-    steps:
-      - name: "Checkout code"
-        uses: "actions/checkout@v4"
-
-      - name: "Install PHP"
-        uses: "shivammathur/setup-php@v2"
-        with:
-          coverage: "none"
-          php-version: "${{ matrix.php-version }}"
-
-      - name: "Set minimum-stability to stable in Composer"
-        run: "composer config minimum-stability stable"
-
-      - name: "Install dependencies with Composer"
-        uses: "ramsey/composer-install@v3"
-
-      - name: "Run a static analysis with vimeo/psalm"
-        run: "vendor/bin/psalm --show-info=false --stats --output-format=github --threads=$(nproc) --php-version=${{ matrix.php-version }}"
+  static-analysis:
+    uses: "doctrine/.github/.github/workflows/[email protected]"
diff --git a/composer.json b/composer.json
@@ -39,18 +39,18 @@
         "symfony/options-resolver": "^6.4 || ^7.0"
     },
     "require-dev": {
+        "composer/semver": "^3.4",
         "doctrine/coding-standard": "^11.0",
         "doctrine/data-fixtures": "^1.7",
+        "phpstan/phpstan": "^2.0",
         "phpunit/phpunit": "^9.5.5",
-        "psalm/plugin-symfony": "^5.0",
         "symfony/browser-kit": "^6.4 || ^7.0",
         "symfony/form": "^6.4 || ^7.0",
         "symfony/phpunit-bridge": "^6.4.1 || ^7.0.1",
         "symfony/security-bundle": "^6.4 || ^7.0",
         "symfony/stopwatch": "^6.4 || ^7.0",
         "symfony/validator": "^6.4 || ^7.0",
-        "symfony/yaml": "^6.4 || ^7.0",
-        "vimeo/psalm": "^5.25"
+        "symfony/yaml": "^6.4 || ^7.0"
     },
     "conflict": {
         "doctrine/data-fixtures": "<1.3"

diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -0,0 +1,10 @@
+includes:
+    - phpstan-baseline.neon
+
+parameters:
+    phpVersion: 80400
+    level: 7
+    paths:
+        - config
+        - src
+        - tests
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
diff --git a/psalm.xml b/psalm.xml
diff --git a/src/CacheWarmer/HydratorCacheWarmer.php b/src/CacheWarmer/HydratorCacheWarmer.php
@@ -26,8 +26,6 @@
  * since this information is necessary to build the hydrators in the first place.
  *
  * @internal
- *
- * @psalm-suppress ContainerDependency
  */
 class HydratorCacheWarmer implements CacheWarmerInterface
 {

diff --git a/src/CacheWarmer/PersistentCollectionCacheWarmer.php b/src/CacheWarmer/PersistentCollectionCacheWarmer.php
@@ -27,8 +27,6 @@
  * since this information is necessary to build the persistent collections in the first place.
  *
  * @internal
- *
- * @psalm-suppress ContainerDependency
  */
 class PersistentCollectionCacheWarmer implements CacheWarmerInterface
 {

diff --git a/src/CacheWarmer/ProxyCacheWarmer.php b/src/CacheWarmer/ProxyCacheWarmer.php
@@ -28,8 +28,6 @@
  * since this information is necessary to build the proxies in the first place.
  *
  * @internal
- *
- * @psalm-suppress ContainerDependency
  */
 class ProxyCacheWarmer implements CacheWarmerInterface
 {

diff --git a/src/Command/LoadDataFixturesDoctrineODMCommand.php b/src/Command/LoadDataFixturesDoctrineODMCommand.php
@@ -8,6 +8,7 @@
 use Doctrine\Bundle\MongoDBBundle\ManagerRegistry;
 use Doctrine\Common\DataFixtures\Executor\MongoDBExecutor;
 use Doctrine\Common\DataFixtures\Purger\MongoDBPurger;
+use Psr\Log\AbstractLogger;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -83,8 +84,23 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         $purger   = new MongoDBPurger($dm);
         $executor = new MongoDBExecutor($dm, $purger);
-        $executor->setLogger(static function ($message) use ($output): void {
-            $output->writeln(sprintf('  <comment>></comment> <info>%s</info>', $message));
+
+        $executor->setLogger(new class ($output) extends AbstractLogger {
+            public function __construct(private OutputInterface $output)
+            {
+            }
+
+            /** {@inheritDoc} */
+            public function log($level, $message, array $context = []): void
+            {
+                $this->output->writeln(sprintf('  <comment>></comment> <info>%s</info>', $message));
+            }
+
+            /** @deprecated to be removed when dropping support for doctrine/data-fixtures <1.8 */
+            public function __invoke(string $message): void
+            {
+                $this->log(0, $message);
+            }
         });
         $executor->execute($fixtures, $input->getOption('append'));
 

diff --git a/src/DependencyInjection/DoctrineMongoDBExtension.php b/src/DependencyInjection/DoctrineMongoDBExtension.php
@@ -384,7 +384,6 @@ protected function loadConnections(array $connections, ContainerBuilder $contain
 
     private function loadMessengerServices(ContainerBuilder $container, FileLoader $loader): void
     {
-        /** @psalm-suppress UndefinedClass Optional dependency */
         if (! interface_exists(MessageBusInterface::class) || ! class_exists(DoctrineClearEntityManagerWorkerSubscriber::class)) {
             return;
         }
@@ -568,8 +567,6 @@ public function getXsdValidationBasePath(): string
      * Loads a cache driver.
      *
      * @throws InvalidArgumentException
-     *
-     * @psalm-suppress UndefinedClass this won't be necessary when removing metadata cache configuration
      */
     protected function loadCacheDriver(string $cacheName, string $objectManagerName, array $cacheDriver, ContainerBuilder $container): string
     {

diff --git a/src/Repository/ContainerRepositoryFactory.php b/src/Repository/ContainerRepositoryFactory.php
@@ -33,9 +33,9 @@ public function __construct(private ContainerInterface $container)
     }
 
     /**
-     * @psalm-param class-string<T> $documentName
+     * @phpstan-param class-string<T> $documentName
      *
-     * @psalm-return ObjectRepository<T>
+     * @phpstan-return ObjectRepository<T>
      *
      * @template T of object
      */
@@ -73,27 +73,27 @@ public function getRepository(DocumentManager $documentManager, string $document
     }
 
     /**
-     * @psalm-param ClassMetadata<T> $metadata
+     * @phpstan-param ClassMetadata<T> $metadata
      *
-     * @psalm-return ObjectRepository<T>
+     * @phpstan-return ObjectRepository<T>
      *
      * @template T of object
      */
     private function getOrCreateRepository(DocumentManager $documentManager, ClassMetadata $metadata): ObjectRepository
     {
         $repositoryHash = $metadata->getName() . spl_object_hash($documentManager);
         if (isset($this->managedRepositories[$repositoryHash])) {
-            /** @psalm-var ObjectRepository<T> */
+            /** @phpstan-var ObjectRepository<T> */
             return $this->managedRepositories[$repositoryHash];
         }
 
         if ($metadata->customRepositoryClassName) {
             $repositoryClassName = $metadata->customRepositoryClassName;
         } elseif ($metadata->isFile) {
-            /** @psalm-var class-string<GridFSRepository<T>> $repositoryClassName */
+            /** @phpstan-var class-string<GridFSRepository<T>> $repositoryClassName */
             $repositoryClassName = $documentManager->getConfiguration()->getDefaultGridFSRepositoryClassName();
         } else {
-            /** @psalm-var class-string<ObjectRepository<T>> $repositoryClassName */
+            /** @phpstan-var class-string<ObjectRepository<T>> $repositoryClassName */
             $repositoryClassName = $documentManager->getConfiguration()->getDefaultDocumentRepositoryClassName();
         }
 

diff --git a/src/Repository/ServiceRepositoryTrait.php b/src/Repository/ServiceRepositoryTrait.php
@@ -17,7 +17,7 @@ trait ServiceRepositoryTrait
     /**
      * @param ManagerRegistry $registry      The ManagerRegistry to use
      * @param string          $documentClass The class name of the entity this repository manages
-     * @psalm-param class-string<T> $documentClass
+     * @phpstan-param class-string<T> $documentClass
      */
     public function __construct(ManagerRegistry $registry, string $documentClass)
     {

diff --git a/tests/DependencyInjection/AbstractMongoDBExtensionTestCase.php b/tests/DependencyInjection/AbstractMongoDBExtensionTestCase.php
@@ -37,7 +37,6 @@ abstract class AbstractMongoDBExtensionTestCase extends TestCase
 {
     abstract protected function loadFromFile(ContainerBuilder $container, string $file): void;
 
-    /** @psalm-suppress UndefinedClass this won't be necessary when removing metadata cache configuration */
     public function testDependencyInjectionConfigurationDefaults(): void
     {
         $container = $this->getContainer();
@@ -335,7 +334,6 @@ public function testDocumentManagerMetadataCacheDriverConfiguration(): void
         $this->assertEquals(ApcuAdapter::class, $definition->getClass());
     }
 
-    /** @psalm-suppress UndefinedClass this won't be necessary when removing metadata cache configuration */
     public function testDocumentManagerMemcachedMetadataCacheDriverConfiguration(): void
     {
         $container = $this->getContainer();

diff --git a/tests/DependencyInjection/DoctrineMongoDBExtensionTest.php b/tests/DependencyInjection/DoctrineMongoDBExtensionTest.php
@@ -311,7 +311,6 @@ public function testPublicServicesAndAliases(): void
 
     public function testMessengerIntegration(): void
     {
-        /** @psalm-suppress UndefinedClass Optional dependency */
         if (! interface_exists(MessageBusInterface::class)) {
             $this->markTestSkipped('Symfony Messenger component is not installed');
         }