Add DrupalRequestStackShimInstantiationRule

Author: mglaman

rules.neon

@@ -18,3 +18,4 @@ rules:
 	- mglaman\PHPStanDrupal\Rules\Deprecations\SymfonyCmfRouteObjectInterfaceConstantsRule
 	- mglaman\PHPStanDrupal\Rules\Deprecations\SymfonyCmfRoutingInClassMethodSignatureRule
 	- mglaman\PHPStanDrupal\Rules\Drupal\DrupalRequestStackShimInClassMethodRule
+	- mglaman\PHPStanDrupal\Rules\Drupal\DrupalRequestStackShimInstantiationRule

src/Rules/Drupal/DrupalRequestStackShimInstantiationRule.php

@@ -0,0 +1,42 @@
+<?php declare(strict_types=1);
+
+namespace mglaman\PHPStanDrupal\Rules\Drupal;
+
+use mglaman\PHPStanDrupal\Internal\DeprecatedScopeCheck;
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use PHPStan\Type\ObjectType;
+
+final class DrupalRequestStackShimInstantiationRule implements Rule
+{
+
+    public function getNodeType(): string
+    {
+        return Node\Expr\New_::class;
+    }
+
+    public function processNode(Node $node, Scope $scope): array
+    {
+        assert($node instanceof Node\Expr\New_);
+        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 [];
+        }
+
+        $symfonyRequestStackType = new ObjectType(\Symfony\Component\HttpFoundation\RequestStack::class);
+        if ($scope->getType($node)->equals($symfonyRequestStackType)) {
+            return [
+                RuleErrorBuilder::message('Do not instantiate 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 [];
+    }
+}

tests/src/Rules/DrupalRequestStackShimInClassMethodRuleTest.php

@@ -34,12 +34,6 @@ public function testRule(): void
                         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/DrupalRequestStackShimInstantiationRuleTest.php

@@ -0,0 +1,37 @@
+<?php declare(strict_types=1);
+
+namespace mglaman\PHPStanDrupal\Tests\Rules;
+
+use mglaman\PHPStanDrupal\Rules\Drupal\DrupalRequestStackShimInstantiationRule;
+use mglaman\PHPStanDrupal\Tests\DrupalRuleTestCase;
+
+final class DrupalRequestStackShimInstantiationRuleTest extends DrupalRuleTestCase
+{
+
+    protected function getRule(): \PHPStan\Rules\Rule
+    {
+        return new DrupalRequestStackShimInstantiationRule();
+    }
+
+    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'],
+                [
+                    [
+                        'Do not instantiate Symfony\Component\HttpFoundation\RequestStack. Use \Drupal\Core\Http\RequestStack instead for forward compatibility to Symfony 5.',
+                        11,
+                        'Change record: https://www.drupal.org/node/3253744',
+                    ],
+                ]
+            );
+        }
+    }
+
+}