Merge pull request #517 from goaop/feature/increase-phpstan-level

feat: Increase the phpstan level

Author: lisachenko

.github/workflows/phpstan.yml

@@ -3,6 +3,8 @@ name: "PHPStan analysis"
 on:
   pull_request:
   push:
+    branches:
+      - master
 
 jobs:
   build:

.github/workflows/phpunit.yml

@@ -3,10 +3,12 @@ name: "PHPUnit tests"
 on:
   pull_request:
   push:
+    branches:
+      - master
 
 jobs:
   phpunit:
-    name: "PHPUnit tests"
+    name: "PHPUnit tests (${{ matrix.dependencies }}, ${{ matrix.php-version }}, ${{ matrix.operating-system }})"
 
     runs-on: ${{ matrix.operating-system }}
 

phpstan-baseline.php

@@ -13,5 +13,31 @@
 	'count' => 1,
 	'path' => __DIR__ . '/src/Proxy/Part/PropertyInterceptionTrait.php',
 ];
+$ignoreErrors[] = [
+	// ClassProxyGenerator is a code generator: the parent class name is valid but the class does not
+	// exist yet at analysis time (it is defined in the weaved file after transformation).
+	// class_exists() cannot be used here as the class is being generated, not loaded.
+	'message' => '#^Parameter \#4 \$extends of class Laminas\\\\Code\\\\Generator\\\\ClassGenerator constructor expects class\-string\|null, string given\.$#',
+	'identifier' => 'argument.type',
+	'count' => 1,
+	'path' => __DIR__ . '/src/Proxy/ClassProxyGenerator.php',
+];
+$ignoreErrors[] = [
+	// Same reason as above: the introduced interface names are class names that will exist at runtime
+	// but cannot be proven as class-string at static analysis time in a code generation context.
+	'message' => '#^Parameter \#5 \$interfaces of class Laminas\\\\Code\\\\Generator\\\\ClassGenerator constructor expects array\<class\-string\>, array\<string\> given\.$#',
+	'identifier' => 'argument.type',
+	'count' => 1,
+	'path' => __DIR__ . '/src/Proxy/ClassProxyGenerator.php',
+];
+$ignoreErrors[] = [
+	// The __joinPoints property is generated by code generation at weave time and populated with
+	// the proper array<array<array<Advice>>> structure. ReflectionProperty::getValue() returns mixed
+	// because PHP reflection cannot know the type of dynamically generated properties.
+	'message' => '#^Parameter \#1 \$classAdvices of static method Go\\\\Proxy\\\\ClassProxyGenerator::wrapWithJoinPoints\(\) expects array\<array\<array\<Go\\\\Aop\\\\Advice\>\>\>, mixed given\.$#',
+	'identifier' => 'argument.type',
+	'count' => 1,
+	'path' => __DIR__ . '/src/Proxy/ClassProxyGenerator.php',
+];
 
 return ['parameters' => ['ignoreErrors' => $ignoreErrors]];

phpstan.neon

@@ -2,6 +2,6 @@ includes:
 	- phpstan-baseline.php
 
 parameters:
-  level: 4
+  level: 9
   paths:
     - src

src/Bridge/Doctrine/MetadataLoadInterceptor.php

@@ -68,23 +68,28 @@ public function loadClassMetadata(LoadClassMetadataEventArgs $args): void
     /**
      * Remove fields in Go! AOP proxied class metadata that are inherited
      * from traits.
+     *
+     * @param ClassMetadata<object> $metadata
      */
     private function removeMappingsFromTraits(ClassMetadata $metadata): void
     {
         $traits = $this->getTraits($metadata->name);
 
         foreach ($traits as $trait) {
+            if (!trait_exists($trait)) {
+                continue;
+            }
             $trait = new ReflectionClass($trait);
 
             foreach ($trait->getProperties() as $property) {
                 $name = $property->getName();
 
                 if (isset($metadata->fieldMappings[$name])) {
-                    $mapping = $metadata->fieldMappings[$name];
+                    $columnName = $metadata->getColumnName($name);
 
                     unset(
                         $metadata->fieldMappings[$name],
-                        $metadata->fieldNames[$mapping['columnName']],
+                        $metadata->fieldNames[$columnName],
                         $metadata->columnNames[$name]
                     );
                 }
@@ -101,6 +106,7 @@ private function removeMappingsFromTraits(ClassMetadata $metadata): void
      * @param class-string $className FQCN
      * @param bool         $autoload  Weather to autoload class.
      *
+     * @return string[]
      * @throws InvalidArgumentException
      * @throws RuntimeException
      */
@@ -113,22 +119,22 @@ private function getTraits(string $className, bool $autoload = true): array
         $traits = [];
         // Get traits of all parent classes
         do {
-            $traits    = array_merge(class_uses($className, $autoload), $traits);
+            $traits    = array_merge(class_uses($className, $autoload) ?: [], $traits);
             $className = get_parent_class($className);
         } while ($className);
 
         $traitsToSearch = $traits;
 
         while (count($traitsToSearch) > 0) {
-            $newTraits      = class_uses(array_pop($traitsToSearch), $autoload);
+            $newTraits      = class_uses(array_pop($traitsToSearch), $autoload) ?: [];
             $traits         = array_merge($newTraits, $traits);
             $traitsToSearch = array_merge($newTraits, $traitsToSearch);
         }
 
         foreach ($traits as $trait => $same) {
-            $traits = array_merge(class_uses($trait, $autoload), $traits);
+            $traits = array_merge(class_uses($trait, $autoload) ?: [], $traits);
         }
 
-        return array_unique(array_map(fn($fqcn) => ltrim($fqcn, '\\'), $traits));
+        return array_values(array_unique(array_map(fn(string $fqcn) => ltrim($fqcn, '\\'), $traits)));
     }
 }

src/Console/Command/BaseAspectCommand.php

@@ -49,8 +49,11 @@ protected function configure(): void
     protected function loadAspectKernel(InputInterface $input, OutputInterface $output): void
     {
         $loader = $input->getArgument('loader');
-        $path   = stream_resolve_include_path($loader);
-        if (!is_readable($path)) {
+        if (!is_string($loader)) {
+            throw new InvalidArgumentException('Loader argument must be a string');
+        }
+        $path = stream_resolve_include_path($loader);
+        if ($path === false || !is_readable($path)) {
             throw new InvalidArgumentException("Invalid loader path: {$loader}");
         }
 

src/Console/Command/DebugAdvisorCommand.php

@@ -135,6 +135,10 @@ private function showAdvisorInformation(SymfonyStyle $io, string $advisorId): vo
         }
     }
 
+    /**
+     * @param ReflectionClass<object> $reflectionClass
+     * @param array<string, array<string, mixed>> $advices
+     */
     private function writeInfoAboutAdvices(SymfonyStyle $io, ReflectionClass $reflectionClass, array $advices): void
     {
         $className = $reflectionClass->getName();

src/Console/Command/DebugAspectCommand.php

@@ -131,6 +131,6 @@ private function getPrettyText(string $comment): string
     {
         $text = preg_replace('|^\s*/?\*+/?|m', '', $comment);
 
-        return $text;
+        return $text ?? $comment;
     }
 }

src/Console/Command/DebugWeavingCommand.php

@@ -77,8 +77,8 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 continue;
             }
 
-            if (isset($proxies[$path]) && $proxies[$path] !== $content) {
-                $io->error(sprintf('Proxy on path "%s" is weaved differnlty on second "warmup" pass.', $path));
+            if ($proxies[$path] !== $content) {
+                $io->error(sprintf('Proxy on path "%s" is weaved differently on second "warmup" pass.', $path));
                 $errors++;
                 continue;
             }
@@ -99,6 +99,8 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
     /**
      * Gets Go! AOP generated proxy classes (paths and their contents) from the cache.
+     *
+     * @return array<string, string>
      */
     private function getProxies(CachePathManager $cachePathManager): array
     {
@@ -118,7 +120,10 @@ private function getProxies(CachePathManager $cachePathManager): array
          */
         foreach ($iterator as $splFileInfo) {
             if ($splFileInfo->isFile()) {
-                $proxies[$splFileInfo->getPathname()] = file_get_contents($splFileInfo->getPathname());
+                $content = file_get_contents($splFileInfo->getPathname());
+                if ($content !== false) {
+                    $proxies[$splFileInfo->getPathname()] = $content;
+                }
             }
         }
 

src/Core/AbstractAspectLoaderExtension.php

@@ -76,12 +76,10 @@ private function makeLexicalAnalyze(
                 $message,
                 $pointcutExpression,
                 (isset($reflection->class) ? $reflection->class . '->' : '') . $reflection->name,
-                method_exists($reflection, 'getFileName')
-                    ? $reflection->getFileName()
-                    : $reflection->getDeclaringClass()->getFileName(),
-                method_exists($reflection, 'getStartLine')
-                    ? $reflection->getStartLine()
-                    : 0
+                $reflection instanceof ReflectionProperty
+                    ? (string) $reflection->getDeclaringClass()->getFileName()
+                    : (string) $reflection->getFileName(),
+                $reflection instanceof ReflectionProperty ? 0 : (int) $reflection->getStartLine()
             );
             throw new UnexpectedValueException($message, 0, $e);
         }
@@ -113,12 +111,10 @@ private function parseTokenStream(
                 $token->getValue(),
                 $pointcutExpression,
                 (isset($reflection->class) ? $reflection->class . '->' : '') . $reflection->name,
-                method_exists($reflection, 'getFileName')
-                    ? $reflection->getFileName()
-                    : $reflection->getDeclaringClass()->getFileName(),
-                method_exists($reflection, 'getStartLine')
-                    ? $reflection->getStartLine()
-                    : 0,
+                $reflection instanceof ReflectionProperty
+                    ? (string) $reflection->getDeclaringClass()->getFileName()
+                    : (string) $reflection->getFileName(),
+                $reflection instanceof ReflectionProperty ? 0 : (int) $reflection->getStartLine(),
                 implode(', ', $e->getExpected())
             );
             throw new UnexpectedValueException($message, 0, $e);