Add static analysis with phpstan

.github/workflows/ci.yaml

@@ -9,7 +9,7 @@ on:
             - 3.x
 
 jobs:
-    run:
+    tests:
         runs-on: ubuntu-latest
         strategy:
             fail-fast: false
@@ -52,3 +52,21 @@ jobs:
 
             - name: Run PHPUnit tests
               run: ./vendor/bin/phpunit
+
+    phpstan:
+        runs-on: ubuntu-latest
+        name: PHPStan
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+
+            - name: Setup PHP
+              uses: shivammathur/setup-php@v2
+              with:
+                php-version: '8.4'
+
+            - name: Install dependencies
+              run: composer update
+
+            - name: Run analysis
+              run: ./vendor/bin/phpstan

composer.json

@@ -50,14 +50,22 @@
     },
     "require-dev": {
         "doctrine/doctrine-bundle": "^1.3 || ^2",
+        "doctrine/mongodb-odm": "^2.16",
+        "doctrine/orm": "^2.6.3 || ^3",
         "friendsofphp/php-cs-fixer": "^3.0.2, !=3.5.0",
+        "phpstan/phpstan": "^2.1",
+        "phpstan/phpstan-phpunit": "^2.0",
+        "phpstan/phpstan-symfony": "^2.0",
         "phpunit/phpunit": "^9.6",
         "symfony/console": "^6.4 || ^7.0",
         "symfony/mailer": "^6.4 || ^7.0",
         "symfony/mime": "^6.4 || ^7.0",
         "symfony/phpunit-bridge": "^6.4 || ^7.0"
     },
     "config": {
+        "platform": {
+            "ext-mongodb": "2.1.8"
+        },
         "sort-packages": true
     },
     "extra": {

phpstan.neon

@@ -0,0 +1,15 @@
+parameters:
+    level: 8
+    inferPrivatePropertyTypeFromConstructor: true
+    treatPhpDocTypesAsCertain: false
+    paths:
+        - src/
+        - tests/
+    ignoreErrors:
+        - '~Method FOS\\UserBundle\\Tests\\[\w\\]+Test::test\w+\(\) has no return type specified.~'
+
+includes:
+    - vendor/phpstan/phpstan-phpunit/extension.neon
+    - vendor/phpstan/phpstan-phpunit/rules.neon
+#    - vendor/phpstan/phpstan-symfony/extension.neon
+#    - vendor/phpstan/phpstan-symfony/rules.neon

src/Controller/ResettingController.php

@@ -71,7 +71,7 @@ public function requestAction(): Response
      */
     public function sendEmailAction(Request $request): Response
     {
-        $username = $request->request->get('username');
+        $username = $request->request->getString('username');
 
         $user = $this->userManager->findUserByUsernameOrEmail($username);
 

src/Doctrine/UserManager.php

@@ -27,15 +27,17 @@ class UserManager extends BaseUserManager
 
     /**
      * @var string
+     *
+     * @phpstan-var class-string<UserInterface>
      */
     private $class;
 
     /**
      * Constructor.
      *
-     * @param string $class
+     * @phpstan-param class-string<UserInterface> $class
      */
-    public function __construct(PasswordUpdaterInterface $passwordUpdater, CanonicalFieldsUpdater $canonicalFieldsUpdater, ObjectManager $om, $class)
+    public function __construct(PasswordUpdaterInterface $passwordUpdater, CanonicalFieldsUpdater $canonicalFieldsUpdater, ObjectManager $om, string $class)
     {
         parent::__construct($passwordUpdater, $canonicalFieldsUpdater);
 
@@ -80,7 +82,7 @@ public function reloadUser(UserInterface $user): void
         $this->objectManager->refresh($user);
     }
 
-    public function updateUser(UserInterface $user, $andFlush = true): void
+    public function updateUser(UserInterface $user, bool $andFlush = true): void
     {
         $this->updateCanonicalFields($user);
         $this->updatePassword($user);

src/Event/FormEvent.php

@@ -29,7 +29,7 @@ final class FormEvent extends Event
     private $request;
 
     /**
-     * @var Response
+     * @var Response|null
      */
     private $response;
 

src/Form/Type/UsernameFormType.php

@@ -41,7 +41,7 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
         $builder->addModelTransformer($this->usernameTransformer);
     }
 
-    public function getParent(): ?string
+    public function getParent(): string
     {
         return TextType::class;
     }

src/Util/CanonicalFieldsUpdater.php

@@ -41,6 +41,8 @@ public function updateCanonicalFields(UserInterface $user): void
      * Canonicalizes an email.
      *
      * @param string|null $email
+     *
+     * @phpstan-return ($email is null ? null : string)
      */
     public function canonicalizeEmail($email): ?string
     {
@@ -51,6 +53,8 @@ public function canonicalizeEmail($email): ?string
      * Canonicalizes a username.
      *
      * @param string|null $username
+     *
+     * @phpstan-return ($username is null ? null : string)
      */
     public function canonicalizeUsername($username): ?string
     {

tests/DependencyInjection/FOSUserExtensionTest.php

@@ -20,12 +20,7 @@
 class FOSUserExtensionTest extends TestCase
 {
     /** @var ContainerBuilder */
-    protected $configuration;
-
-    protected function tearDown(): void
-    {
-        unset($this->configuration);
-    }
+    private $configuration;
 
     public function testUserLoadThrowsExceptionUnlessDatabaseDriverSet()
     {
@@ -157,8 +152,12 @@ public function testDisableChangePassword()
 
     /**
      * @dataProvider providerEmailsDisabledFeature
+     *
+     * @param array<string, mixed>                        $testConfig
+     * @param array{address: string, sender_name: string} $registration
+     * @param array{address: string, sender_name: string} $resetting
      */
-    public function testEmailsDisabledFeature($testConfig, $registration, $resetting)
+    public function testEmailsDisabledFeature(array $testConfig, array $registration, array $resetting)
     {
         $this->configuration = new ContainerBuilder();
         $loader = new FOSUserExtension();
@@ -170,7 +169,10 @@ public function testEmailsDisabledFeature($testConfig, $registration, $resetting
         $this->assertParameter($resetting, 'fos_user.resetting.email.from_address');
     }
 
-    public function providerEmailsDisabledFeature()
+    /**
+     * @return iterable<array{array<string, mixed>, array{address: string, sender_name: string}, array{address: string, sender_name: string}}>
+     */
+    public function providerEmailsDisabledFeature(): iterable
     {
         $configBothFeaturesDisabled = ['registration' => false, 'resetting' => false];
         $configResettingDisabled = ['resetting' => false];
@@ -343,7 +345,7 @@ public function testUserLoadFlashesCanBeDisabled()
     /**
      * @dataProvider userManagerSetFactoryProvider
      */
-    public function testUserManagerSetFactory($dbDriver, $doctrineService)
+    public function testUserManagerSetFactory(string $dbDriver, string $doctrineService)
     {
         $this->configuration = new ContainerBuilder();
         $loader = new FOSUserExtension();
@@ -357,6 +359,7 @@ public function testUserManagerSetFactory($dbDriver, $doctrineService)
 
         $factory = $definition->getFactory();
 
+        $this->assertIsArray($factory);
         $this->assertInstanceOf('Symfony\Component\DependencyInjection\Reference', $factory[0]);
         $this->assertSame('fos_user.doctrine_registry', (string) $factory[0]);
         $this->assertSame('getManager', $factory[1]);
@@ -373,27 +376,23 @@ public function userManagerSetFactoryProvider(): iterable
         ];
     }
 
-    protected function createEmptyConfiguration()
+    protected function createEmptyConfiguration(): void
     {
         $this->configuration = new ContainerBuilder();
         $loader = new FOSUserExtension();
         $config = $this->getEmptyConfig();
         $loader->load([$config], $this->configuration);
-        $this->assertTrue($this->configuration instanceof ContainerBuilder);
     }
 
-    protected function createFullConfiguration()
+    protected function createFullConfiguration(): void
     {
         $this->configuration = new ContainerBuilder();
         $loader = new FOSUserExtension();
         $config = $this->getFullConfig();
         $loader->load([$config], $this->configuration);
-        $this->assertTrue($this->configuration instanceof ContainerBuilder);
     }
 
     /**
-     * getEmptyConfig.
-     *
      * @return array<string, mixed>
      */
     protected function getEmptyConfig(): array

tests/Security/UserCheckerTest.php

@@ -46,7 +46,7 @@ public function testCheckPostAuthSuccess()
         $this->expectNotToPerformAssertions();
     }
 
-    private function getUser($isEnabled): User
+    private function getUser(bool $isEnabled): User
     {
         $userMock = $this->getMockBuilder('FOS\UserBundle\Model\User')->getMock();
         $userMock