[CI] Added phpstan

.github/workflows/ci.yaml

@@ -69,6 +69,9 @@ jobs:
       - name: Run test suite
         run: composer run-script --timeout=600 test
 
+      - name: Run PHPStan analysis
+        run: composer run-script phpstan
+
   integration-tests:
     name: Integration yests
     needs: tests

composer.json

@@ -22,13 +22,17 @@
         "ibexa/design-engine": "~4.6.0@dev",
         "ibexa/user": "~4.6.0@dev",
         "ibexa/fieldtype-richtext": "~4.6.0@dev",
+        "ibexa/phpstan": "~4.6.0@dev",
         "ibexa/rest": "~4.6.0@dev",
         "ibexa/search": "~4.6.0@dev",
         "ibexa/test-core": "~4.6.0@dev",
         "ibexa/http-cache": "~4.6.0@dev",
         "ibexa/notifications": "^4.6.x-dev",
         "phpunit/phpunit": "^8.2",
-        "matthiasnoback/symfony-dependency-injection-test": "^4.0"
+        "matthiasnoback/symfony-dependency-injection-test": "^4.0",
+        "phpstan/phpstan": "^2.0",
+        "phpstan/phpstan-phpunit": "^2.0",
+        "phpstan/phpstan-symfony": "^2.0"
     },
     "autoload": {
         "psr-4": {
@@ -55,7 +59,8 @@
         "fix-cs": "php-cs-fixer fix --config=.php-cs-fixer.php -v --show-progress=dots",
         "check-cs": "@fix-cs --dry-run",
         "test": "phpunit -c phpunit.xml",
-        "test-integration": "phpunit -c phpunit.integration.xml"
+        "test-integration": "phpunit -c phpunit.integration.xml",
+        "phpstan": "phpstan analyse"
     },
     "config": {
         "allow-plugins": false

phpstan-baseline.neon

@@ -0,0 +1,43 @@
+parameters:
+	ignoreErrors:
+		-
+			message: '#^Binary operation "\." between array\|bool\|float\|int\|string\|null and ''/vendor/'' results in an error\.$#'
+			identifier: binaryOp.invalid
+			count: 1
+			path: src/bundle/DependencyInjection/IbexaSystemInfoExtension.php
+
+		-
+			message: '#^Method Ibexa\\Bundle\\SystemInfo\\DependencyInjection\\IbexaSystemInfoExtension\:\:getConfiguration\(\) has parameter \$config with no value type specified in iterable type array\.$#'
+			identifier: missingType.iterableValue
+			count: 1
+			path: src/bundle/DependencyInjection/IbexaSystemInfoExtension.php
+
+		-
+			message: '#^Parameter \#4 \$condition of method Doctrine\\DBAL\\Query\\QueryBuilder\:\:innerJoin\(\) expects string\|null, Doctrine\\DBAL\\Query\\Expression\\CompositeExpression given\.$#'
+			identifier: argument.type
+			count: 1
+			path: src/lib/Storage/Metrics/DraftsCountMetrics.php
+
+		-
+			message: '#^Parameter \#1 \$items of class Ibexa\\Bundle\\SystemInfo\\SystemInfo\\Registry\\IdentifierBased constructor expects array\<Ibexa\\Bundle\\SystemInfo\\SystemInfo\\Collector\\SystemInfoCollector\>, array\<Ibexa\\Bundle\\SystemInfo\\SystemInfo\\Collector\\SystemInfoCollector\|PHPUnit\\Framework\\MockObject\\MockObject\> given\.$#'
+			identifier: argument.type
+			count: 3
+			path: tests/bundle/SystemInfo/Registry/IdentifierBasedTest.php
+
+		-
+			message: '#^Method Ibexa\\Tests\\Bundle\\SystemInfo\\View\\SystemInfoViewBuilderTest\:\:getCollectorMock\(\) should return Ibexa\\Bundle\\SystemInfo\\SystemInfo\\Collector\\SystemInfoCollector&PHPUnit\\Framework\\MockObject\\MockObject but returns Ibexa\\Bundle\\SystemInfo\\SystemInfo\\Collector\\SystemInfoCollector\.$#'
+			identifier: return.type
+			count: 1
+			path: tests/bundle/View/SystemInfoViewBuilderTest.php
+
+		-
+			message: '#^Method Ibexa\\Tests\\Bundle\\SystemInfo\\View\\SystemInfoViewBuilderTest\:\:getConfiguratorMock\(\) should return Ibexa\\Core\\MVC\\Symfony\\View\\Configurator&PHPUnit\\Framework\\MockObject\\MockObject but returns Ibexa\\Core\\MVC\\Symfony\\View\\Configurator\.$#'
+			identifier: return.type
+			count: 1
+			path: tests/bundle/View/SystemInfoViewBuilderTest.php
+
+		-
+			message: '#^Method Ibexa\\Tests\\Bundle\\SystemInfo\\View\\SystemInfoViewBuilderTest\:\:getRegistryMock\(\) should return Ibexa\\Bundle\\SystemInfo\\SystemInfo\\SystemInfoCollectorRegistry&PHPUnit\\Framework\\MockObject\\MockObject but returns Ibexa\\Bundle\\SystemInfo\\SystemInfo\\SystemInfoCollectorRegistry\.$#'
+			identifier: return.type
+			count: 1
+			path: tests/bundle/View/SystemInfoViewBuilderTest.php

phpstan.neon

@@ -0,0 +1,15 @@
+includes:
+    - phpstan-baseline.neon
+    - vendor/phpstan/phpstan-phpunit/extension.neon
+    - vendor/phpstan/phpstan-symfony/extension.neon
+    - vendor/ibexa/phpstan/extension.neon
+
+parameters:
+    level: 8
+    paths:
+        - src
+        - tests
+    treatPhpDocTypesAsCertain: false
+    ignoreErrors:
+        -
+            message: "#^Cannot call method (fetchOne|fetchColumn|fetchAllAssociative|fetchAssociative|fetchAllKeyValue|fetchFirstColumn)\\(\\) on Doctrine\\\\DBAL\\\\ForwardCompatibility\\\\Result\\|int\\|string\\.$#"

src/bundle/Command/SystemInfoDumpCommand.php

@@ -29,10 +29,7 @@ public function __construct(SystemInfoCollectorRegistry $systemInfoCollectorRegi
         parent::__construct();
     }
 
-    /**
-     * Define command and input options.
-     */
-    protected function configure()
+    protected function configure(): void
     {
         $this
             ->setName('ibexa:system-info:dump')
@@ -79,9 +76,9 @@ protected function configure()
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         if ($input->getOption('list-info-collectors')) {
-            $output->writeln('Available info collectors:', true);
+            $output->writeln('Available info collectors:', OutputInterface::OUTPUT_NORMAL);
             foreach ($this->systemInfoCollectorRegistry->getIdentifiers() as $identifier) {
-                $output->writeln("  $identifier", true);
+                $output->writeln("  $identifier", OutputInterface::OUTPUT_NORMAL);
             }
 
             return Command::SUCCESS;

src/bundle/Controller/SystemInfoController.php

@@ -25,7 +25,7 @@ public function __construct(SystemInfoCollectorRegistry $collectorRegistry)
         $this->collectorRegistry = $collectorRegistry;
     }
 
-    public function performAccessCheck()
+    public function performAccessCheck(): void
     {
         parent::performAccessCheck();
         $this->denyAccessUnlessGranted(new Attribute('setup', 'system_info'));
@@ -43,23 +43,20 @@ public function infoAction(): Response
         ]);
     }
 
-    public function viewInfoAction(SystemInfoView $view)
+    public function viewInfoAction(SystemInfoView $view): SystemInfoView
     {
         return $view;
     }
 
     /**
      * Renders a PHP info page.
-     *
-     * @return \Symfony\Component\HttpFoundation\Response
      */
     public function phpinfoAction(): Response
     {
         ob_start();
         phpinfo();
-        $response = new Response(ob_get_clean());
 
-        return $response;
+        return new Response(ob_get_clean() ?: '');
     }
 }
 

src/bundle/DependencyInjection/Compiler/OutputFormatPass.php

@@ -18,7 +18,7 @@ class OutputFormatPass implements CompilerPassInterface
      *
      * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container
      */
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (!$container->has(OutputFormatRegistry::class)) {
             return;

src/bundle/DependencyInjection/Compiler/SystemInfoCollectorPass.php

@@ -15,12 +15,7 @@
 
 class SystemInfoCollectorPass implements CompilerPassInterface
 {
-    /**
-     * Registers the SystemInfoCollector into the system info collector registry.
-     *
-     * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container
-     */
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (!$container->has(IdentifierBased::class)) {
             return;

src/bundle/DependencyInjection/Compiler/SystemInfoTabGroupPass.php

@@ -18,12 +18,10 @@
 class SystemInfoTabGroupPass implements CompilerPassInterface
 {
     /**
-     * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container
-     *
      * @throws \Symfony\Component\DependencyInjection\Exception\InvalidArgumentException
      * @throws \Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException
      */
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (!$container->hasDefinition(TabRegistry::class)) {
             return;

src/bundle/DependencyInjection/IbexaSystemInfoExtension.php

@@ -29,6 +29,9 @@ public function getAlias()
         return self::EXTENSION_NAME;
     }
 
+    /**
+     * @return \Ibexa\Bundle\SystemInfo\DependencyInjection\Configuration
+     */
     public function getConfiguration(array $config, ContainerBuilder $container)
     {
         return new Configuration();
@@ -37,7 +40,7 @@ public function getConfiguration(array $config, ContainerBuilder $container)
     /**
      * {@inheritdoc}
      */
-    public function load(array $configs, ContainerBuilder $container)
+    public function load(array $configs, ContainerBuilder $container): void
     {
         $loader = new Loader\YamlFileLoader(
             $container,
@@ -61,7 +64,7 @@ public function load(array $configs, ContainerBuilder $container)
         }
     }
 
-    public function prepend(ContainerBuilder $container)
+    public function prepend(ContainerBuilder $container): void
     {
         $this->prependJMSTranslation($container);
     }

src/bundle/IbexaSystemInfoBundle.php

@@ -16,7 +16,7 @@
 
 class IbexaSystemInfoBundle extends Bundle
 {
-    public function build(ContainerBuilder $container)
+    public function build(ContainerBuilder $container): void
     {
         parent::build($container);
         $container->addCompilerPass(new SystemInfoCollectorPass());

src/bundle/SystemInfo/Collector/ConfigurationSymfonyKernelSystemInfoCollector.php

@@ -32,10 +32,13 @@ class ConfigurationSymfonyKernelSystemInfoCollector implements SystemInfoCollect
      *   'AsseticBundle' => 'Symfony\\Bundle\\AsseticBundle\\AsseticBundle',
      * )
      *
-     * @var array
+     * @var array<string, class-string>
      */
     private $bundles;
 
+    /**
+     * @param array<string, class-string> $bundles
+     */
     public function __construct(Kernel $kernel, array $bundles)
     {
         $this->kernel = $kernel;

src/bundle/SystemInfo/Collector/EzcPhpSystemInfoCollector.php

@@ -28,8 +28,6 @@ public function __construct(EzcSystemInfoWrapper $ezcSystemInfo)
      * Collects information about the PHP installation Ibexa DXP is using.
      *  - php version
      *  - php accelerator info.
-     *
-     * @return \Ibexa\Bundle\SystemInfo\SystemInfo\Value\PhpSystemInfo
      */
     public function collect(): PhpSystemInfo
     {

src/bundle/SystemInfo/Collector/IbexaSystemInfoCollector.php

@@ -146,7 +146,7 @@ class IbexaSystemInfoCollector implements SystemInfoCollector
     private $kernelProjectDir;
 
     /**
-     * @param \Ibexa\Bundle\SystemInfo\SystemInfo\Collector\JsonComposerLockSystemInfoCollector|\Ibexa\Bundle\SystemInfo\SystemInfo\Collector\SystemInfoCollector $composerCollector
+     * @param \Ibexa\Bundle\SystemInfo\SystemInfo\Collector\JsonComposerLockSystemInfoCollector|SystemInfoCollector $composerCollector
      * @param bool $debug
      */
     public function __construct(
@@ -155,7 +155,10 @@ public function __construct(
         bool $debug = false
     ) {
         try {
-            $this->composerInfo = $composerCollector->collect();
+            $composerInfo = $composerCollector->collect();
+            if ($composerInfo instanceof ComposerSystemInfo) {
+                $this->composerInfo = $composerInfo;
+            }
         } catch (ComposerLockFileNotFoundException | ComposerFileValidationException $e) {
             // do nothing
         }
@@ -225,19 +228,13 @@ private function extractComposerInfo(IbexaSystemInfo $ibexa): void
         $ibexa->stability = $ibexa->lowestStability = self::getStability($this->composerInfo);
     }
 
-    /**
-     * @throws \Exception
-     */
     private function getEOMDate(string $ibexaRelease): ?DateTime
     {
         return isset(self::EOM[$ibexaRelease]) ?
             new DateTime(self::EOM[$ibexaRelease]) :
             null;
     }
 
-    /**
-     * @throws \Exception
-     */
     private function getEOLDate(string $ibexaRelease): ?DateTime
     {
         return isset(self::EOL[$ibexaRelease]) ?
@@ -254,6 +251,9 @@ private static function getStability(ComposerSystemInfo $composerInfo): string
             $stabilityFlags[$composerInfo->minimumStability] :
             $stabilityFlags['stable'];
 
+        if ($composerInfo->packages === null) {
+            return Stability::STABILITIES[$stabilityFlag];
+        }
         // Check if any of the watched packages has lower stability than root
         foreach ($composerInfo->packages as $name => $package) {
             if (!preg_match(self::PACKAGE_WATCH_REGEX, $name)) {
@@ -272,6 +272,9 @@ private static function getStability(ComposerSystemInfo $composerInfo): string
         return Stability::STABILITIES[$stabilityFlag];
     }
 
+    /**
+     * @param list<string> $packageNames
+     */
     private static function hasAnyPackage(
         ComposerSystemInfo $composerInfo,
         array $packageNames