Add DrupalRequestStackShimInClassMethodRule rule

Author: mglaman

rules.neon

@@ -17,3 +17,4 @@ rules:
 	- mglaman\PHPStanDrupal\Rules\Drupal\EntityQuery\EntityQueryHasAccessCheckRule
 	- mglaman\PHPStanDrupal\Rules\Deprecations\SymfonyCmfRouteObjectInterfaceConstantsRule
 	- mglaman\PHPStanDrupal\Rules\Deprecations\SymfonyCmfRoutingInClassMethodSignatureRule
+	- mglaman\PHPStanDrupal\Rules\Drupal\DrupalRequestStackShimInClassMethodRule

src/Rules/Deprecations/SymfonyCmfRoutingInClassMethodSignatureRule.php

@@ -27,7 +27,7 @@ public function processNode(Node $node, Scope $scope): array
             return [];
         }
         [$major, $minor] = explode('.', \Drupal::VERSION, 3);
-        if ($major !== '9' && (int) $minor > 1) {
+        if ($major !== '9' || (int) $minor < 1) {
             return [];
         }
         $method = $scope->getFunction();

src/Rules/Drupal/DrupalRequestStackShimInClassMethodRule.php

@@ -0,0 +1,71 @@
+<?php declare(strict_types=1);
+
+namespace mglaman\PHPStanDrupal\Rules\Drupal;
+
+use mglaman\PHPStanDrupal\Internal\DeprecatedScopeCheck;
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Node\InClassMethodNode;
+use PHPStan\Reflection\MethodReflection;
+use PHPStan\Reflection\ParametersAcceptorSelector;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use PHPStan\Type\ObjectType;
+
+final class DrupalRequestStackShimInClassMethodRule implements Rule
+{
+
+    public function getNodeType(): string
+    {
+        return InClassMethodNode::class;
+    }
+
+    public function processNode(Node $node, Scope $scope): array
+    {
+        assert($node instanceof InClassMethodNode);
+        if (DeprecatedScopeCheck::inDeprecatedScope($scope)) {
+            return [];
+        }
+        [$major, $minor] = explode('.', \Drupal::VERSION, 3);
+        // Only valid for 9.3 -> 9.5. Deprecated in Drupal 10.
+        if ($major !== '9' || (int) $minor < 3) {
+            return [];
+        }
+        $method = $scope->getFunction();
+        if (!$method instanceof MethodReflection) {
+            throw new \PHPStan\ShouldNotHappenException();
+        }
+        $errors = [];
+
+        $symfonyRequestStackType = new ObjectType(\Symfony\Component\HttpFoundation\RequestStack::class);
+
+        $methodSignature = ParametersAcceptorSelector::selectSingle($method->getVariants());
+        foreach ($methodSignature->getParameters() as $parameter) {
+            foreach ($parameter->getType()->getReferencedClasses() as $referencedClass) {
+                $referencedClassType = new ObjectType($referencedClass);
+                if ($referencedClassType->equals($symfonyRequestStackType)) {
+                    $errors[] = RuleErrorBuilder::message(
+                        sprintf(
+                            'Parameter $%s of method %s() uses \Symfony\Component\HttpFoundation\RequestStack. Use \Drupal\Core\Http\RequestStack instead for forward compatibility to Symfony 5.',
+                            $parameter->getName(),
+                            $method->getName(),
+                        )
+                    )
+                        ->tip('Change record: https://www.drupal.org/node/3253744')
+                        ->build();
+                }
+            }
+        }
+        $returnClasses = $methodSignature->getReturnType()->getReferencedClasses();
+        foreach ($returnClasses as $returnClass) {
+            $returnType = new ObjectType($returnClass);
+            if ($returnType->equals($symfonyRequestStackType)) {
+                $errors[] = RuleErrorBuilder::message('Return type of method %s::%s() uses \Symfony\Component\HttpFoundation\RequestStack. Use \Drupal\Core\Http\RequestStack instead for forward compatibility to Symfony 5.')
+                    ->tip('Change record: https://www.drupal.org/node/3253744')
+                    ->build();
+            }
+        }
+
+        return $errors;
+    }
+}

tests/src/Rules/DrupalRequestStackShimInClassMethodRuleTest.php

@@ -0,0 +1,48 @@
+<?php declare(strict_types=1);
+
+namespace mglaman\PHPStanDrupal\Tests\Rules;
+
+use mglaman\PHPStanDrupal\Rules\Drupal\DrupalRequestStackShimInClassMethodRule;
+use mglaman\PHPStanDrupal\Tests\DrupalRuleTestCase;
+
+final class DrupalRequestStackShimInClassMethodRuleTest extends DrupalRuleTestCase
+{
+
+    protected function getRule(): \PHPStan\Rules\Rule
+    {
+        return new DrupalRequestStackShimInClassMethodRule();
+    }
+
+    public function testRule(): void
+    {
+        [$version] = explode('.', \Drupal::VERSION, 2);
+        if ($version === '8') {
+            $this->analyse([__DIR__.'/data/request-stack.php'], []);
+        } elseif ($version === '10') {
+            self::markTestSkipped('Not tested on 10.x.x');
+        } else {
+            $this->analyse(
+                [__DIR__.'/data/request-stack.php'],
+                [
+                    [
+                        'Parameter $stack of method __construct() uses \Symfony\Component\HttpFoundation\RequestStack. Use \Drupal\Core\Http\RequestStack instead for forward compatibility to Symfony 5.',
+                        6,
+                        'Change record: https://www.drupal.org/node/3253744',
+                    ],
+                    [
+                        'Return type of method %s::%s() uses \Symfony\Component\HttpFoundation\RequestStack. Use \Drupal\Core\Http\RequestStack instead for forward compatibility to Symfony 5.',
+                        9,
+                        'Change record: https://www.drupal.org/node/3253744',
+                    ],
+                    // @todo needs specific \PhpParser\Node\Expr\New_ rule.
+                    [
+                        '',
+                        11,
+                        'Change record: https://www.drupal.org/node/3253744',
+                    ],
+                ]
+            );
+        }
+    }
+
+}

tests/src/Rules/data/request-stack.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace DrupalRequestStackShim;
+
+class Foo {
+    public function __construct(\Symfony\Component\HttpFoundation\RequestStack $stack)
+    {
+    }
+    public function getStack(): \Symfony\Component\HttpFoundation\RequestStack
+    {
+        return new \Symfony\Component\HttpFoundation\RequestStack();
+    }
+}
+class Bar {
+    public function __construct(\Drupal\Core\Http\RequestStack $stack)
+    {
+    }
+    public function getStack(): \Drupal\Core\Http\RequestStack
+    {
+        return new \Drupal\Core\Http\RequestStack();
+    }
+}