Merge pull request #459 from mglaman/gh458

More specific rules for RequestStack shim

Author: mglaman

rules.neon

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

src/Rules/Drupal/DrupalRequestStackShimInClassMethodRule.php

@@ -0,0 +1,56 @@
+<?php declare(strict_types=1);
+
+namespace mglaman\PHPStanDrupal\Rules\Drupal;
+
+use Drupal\Core\Http\RequestStack as DrupalRequestStack;
+use mglaman\PHPStanDrupal\Internal\DeprecatedScopeCheck;
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use PHPStan\Type\ObjectType;
+use Symfony\Component\HttpFoundation\RequestStack as SymfonyRequestStack;
+
+final class RequestStackGetMainRequestRule implements Rule
+{
+
+    public function getNodeType(): string
+    {
+        return Node\Expr\MethodCall::class;
+    }
+
+    public function processNode(Node $node, Scope $scope): array
+    {
+        assert($node instanceof Node\Expr\MethodCall);
+        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 [];
+        }
+        if (!$node->name instanceof Node\Identifier) {
+            return [];
+        }
+        $method_name = $node->name->toString();
+        if ($method_name !== 'getMasterRequest') {
+            return [];
+        }
+        $type = $scope->getType($node->var);
+        $symfonyRequestStackType = new ObjectType(SymfonyRequestStack::class);
+        if ($symfonyRequestStackType->isSuperTypeOf($type)->yes()) {
+            $message = sprintf(
+                '%s::getMasterRequest() is deprecated in drupal:9.3.0 and is removed from drupal:10.0.0 for Symfony 6 compatibility. Use the forward compatibility shim class %s and its getMainRequest() method instead.',
+                SymfonyRequestStack::class,
+                DrupalRequestStack::class
+            );
+            return [
+                RuleErrorBuilder::message($message)
+                ->tip('Change record: https://www.drupal.org/node/3253744')
+                ->build(),
+            ];
+        }
+        return [];
+    }
+}

src/Rules/Drupal/DrupalRequestStackShimInstantiationRule.php

@@ -0,0 +1,43 @@
+<?php declare(strict_types=1);
+
+namespace mglaman\PHPStanDrupal\Tests\Rules;
+
+use mglaman\PHPStanDrupal\Rules\Drupal\DrupalRequestStackShimInstantiationRule;
+use mglaman\PHPStanDrupal\Rules\Drupal\RequestStackGetMainRequestRule;
+use mglaman\PHPStanDrupal\Tests\DrupalRuleTestCase;
+
+final class RequestStackGetMainRequestRuleTest extends DrupalRuleTestCase
+{
+
+    protected function getRule(): \PHPStan\Rules\Rule
+    {
+        return new RequestStackGetMainRequestRule();
+    }
+
+    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'],
+                [
+                    [
+                        'Symfony\Component\HttpFoundation\RequestStack::getMasterRequest() is deprecated in drupal:9.3.0 and is removed from drupal:10.0.0 for Symfony 6 compatibility. Use the forward compatibility shim class Drupal\Core\Http\RequestStack and its getMainRequest() method instead.',
+                        17,
+                        'Change record: https://www.drupal.org/node/3253744',
+                    ],
+                    [
+                        'Symfony\Component\HttpFoundation\RequestStack::getMasterRequest() is deprecated in drupal:9.3.0 and is removed from drupal:10.0.0 for Symfony 6 compatibility. Use the forward compatibility shim class Drupal\Core\Http\RequestStack and its getMainRequest() method instead.',
+                        29,
+                        'Change record: https://www.drupal.org/node/3253744',
+                    ],
+                ]
+            );
+        }
+    }
+
+}

src/Rules/Drupal/RequestStackGetMainRequestRule.php

@@ -2,6 +2,8 @@
 
 namespace DrupalRequestStackShim;
 
+use Symfony\Component\HttpFoundation\Request;
+
 class Foo {
     public function __construct(\Symfony\Component\HttpFoundation\RequestStack $stack)
     {
@@ -10,6 +12,10 @@ public function getStack(): \Symfony\Component\HttpFoundation\RequestStack
     {
         return new \Symfony\Component\HttpFoundation\RequestStack();
     }
+
+    public function a(): ?Request {
+        return $this->getStack()->getMasterRequest();
+    }
 }
 class Bar {
     public function __construct(\Drupal\Core\Http\RequestStack $stack)
@@ -19,4 +25,10 @@ public function getStack(): \Drupal\Core\Http\RequestStack
     {
         return new \Drupal\Core\Http\RequestStack();
     }
+    public function a(): ?Request {
+        return $this->getStack()->getMasterRequest();
+    }
+    public function b(): ?Request {
+        return $this->getStack()->getMainRequest();
+    }
 }