Add requirements check for generated routes

Author: DaDeather

src/Rules/Symfony/UrlGeneratorInterfaceUnknownRouteRule.php

@@ -10,6 +10,7 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
 use PHPStan\Type\ObjectType;
+use PHPStan\Type\TypeUtils;
 
 /**
  * @implements Rule<MethodCall>
@@ -65,6 +66,32 @@ public function processNode(Node $node, Scope $scope): array
             return [sprintf('Route with name "%s" does not exist.', $routeName)];
         }
 
+        $routeRequirements = $this->urlGeneratingRoutesMap->getRouteRequirements($routeName);
+        if (
+            $routeRequirements !== []
+            && count($node->getArgs()) < 2
+        ) {
+            return [sprintf('Route with name "%s" has requires parameters "%s" to be given.', $routeName, implode(', ', array_keys($routeRequirements)))];
+        }
+
+        if (
+            $routeRequirements !== []
+            && $scope->getType($node->getArgs()[1]->value)->isArray()->yes()
+        ) {
+            $requiredParamsArrayType = $scope->getType($node->getArgs()[1]->value);
+            $requiredParamConstantStrings = TypeUtils::getConstantStrings($requiredParamsArrayType->getIterableKeyType());
+
+            foreach ($routeRequirements as $name => $requirement) {
+                foreach ($requiredParamConstantStrings as $requiredParamConstantString) {
+                    if ($name === $requiredParamConstantString->getValue()) {
+                        continue 2;
+                    }
+                }
+
+                return [sprintf('Route with name "%s" is missing required param %s.', $routeName, $name)];
+            }
+        }
+
         return [];
     }
 }

src/Symfony/DefaultUrlGeneratingRoutesMap.php

@@ -33,6 +33,17 @@ public function hasRouteName(string $name): bool
         return false;
     }
 
+    public function getRouteRequirements(string $name): array
+    {
+        foreach ($this->routes as $route) {
+            if ($route->getName() === $name) {
+                return $route->getRequiredUrlParams();
+            }
+        }
+
+        return [];
+    }
+
     public static function getRouteNameFromNode(Expr $node, Scope $scope): ?string
     {
         $strings = TypeUtils::getConstantStrings($scope->getType($node));

src/Symfony/FakeUrlGeneratingRoutesMap.php

@@ -14,6 +14,11 @@ public function hasRouteName(string $name): bool
         return false;
     }
 
+    public function getRouteRequirements(string $name): array
+    {
+        return [];
+    }
+
     public static function getRouteNameFromNode(Expr $node, Scope $scope): ?string
     {
         return null;

src/Symfony/PhpUrlGeneratingRoutesMapFactory.php

@@ -43,7 +43,11 @@ public function create(): UrlGeneratingRoutesMap
                 continue;
             }
 
-            $routes[] = new UrlGeneratingRoute($routeName, $routeConfiguration[1]['_controller']);
+            $routes[] = new UrlGeneratingRoute(
+                $routeName,
+                $routeConfiguration[1]['_controller'],
+                $routeConfiguration[2] ?? []
+            );
         }
 
         return new DefaultUrlGeneratingRoutesMap($routes);

src/Symfony/UrlGeneratingRoute.php

@@ -12,12 +12,20 @@ class UrlGeneratingRoute implements UrlGeneratingRoutesDefinition
     /** @var string */
     private $controller;
 
+    /** @var array<string, string> */
+    private $urlRequiredParams;
+
+    /**
+     * @param array<string, string> $urlParams
+     */
     public function __construct(
         string $name,
-        string $controller
+        string $controller,
+        array $urlParams
     ) {
         $this->name = $name;
         $this->controller = $controller;
+        $this->urlRequiredParams = $urlParams;
     }
 
     public function getName(): string
@@ -29,4 +37,10 @@ public function getController(): ?string
     {
         return $this->controller;
     }
+
+    /** @return array<string, string> */
+    public function getRequiredUrlParams(): array
+    {
+        return $this->urlRequiredParams;
+    }
 }

src/Symfony/UrlGeneratingRoutesDefinition.php

@@ -9,4 +9,7 @@ interface UrlGeneratingRoutesDefinition
     public function getName(): string;
 
     public function getController(): ?string;
+
+    /** @return array<string, string> */
+    public function getRequiredUrlParams(): array;
 }

src/Symfony/UrlGeneratingRoutesMap.php

@@ -11,5 +11,8 @@ interface UrlGeneratingRoutesMap
 {
     public function hasRouteName(string $name): bool;
 
+    /** @return array<string, string> */
+    public function getRouteRequirements(string $name): array;
+
     public static function getRouteNameFromNode(Expr $node, Scope $scope): ?string;
 }

tests/Rules/Symfony/ExampleControllerWithRoutingAndRequirements.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DaDaDev\Rules\Symfony;
+
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+
+final class ExampleControllerWithRoutingAndRequirements extends AbstractController
+{
+    public function generateSomeRoute1(): void
+    {
+        $this->generateUrl('someRoute1');
+    }
+
+    public function generateSomeRoute2(): void
+    {
+        $this->generateUrl('someRoute1', ['number' => 1]);
+    }
+
+    public function generateSomeRoute3(): void
+    {
+        $this->generateUrl('someRoute1', ['date' => '2022-05-25']);
+    }
+
+    public function generateSomeRoute4(): void
+    {
+        $this->generateUrl('someRoute1', ['number' => 1, 'date' => '2022-05-25']);
+    }
+}

tests/Rules/Symfony/UrlGeneratorInterfaceRouteWithRequirementsRuleTest.php

@@ -0,0 +1,55 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DaDaDev\Rules\Symfony;
+
+use DaDaDev\Symfony\Configuration;
+use DaDaDev\Symfony\PhpUrlGeneratingRoutesMapFactory;
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+
+/**
+ * @extends RuleTestCase<UrlGeneratorInterfaceUnknownRouteRule>
+ */
+final class UrlGeneratorInterfaceRouteWithRequirementsRuleTest extends RuleTestCase
+{
+    protected function getRule(): Rule
+    {
+        return new UrlGeneratorInterfaceUnknownRouteRule((new PhpUrlGeneratingRoutesMapFactory(new Configuration(['urlGeneratingRulesFile' => __DIR__ . '/url_generating_routes_with_requirements.php'])))->create());
+    }
+
+    public function testGenerate(): void
+    {
+        if (!class_exists('Symfony\Bundle\FrameworkBundle\Controller\AbstractController')) {
+            self::markTestSkipped();
+        }
+
+        $this->analyse(
+            [
+                __DIR__ . '/ExampleControllerWithRoutingAndRequirements.php',
+            ],
+            [
+                [
+                    'Route with name "someRoute1" has requires parameters "number, date" to be given.',
+                    13,
+                ],
+                [
+                    'Route with name "someRoute1" is missing required param date.',
+                    18,
+                ],
+                [
+                    'Route with name "someRoute1" is missing required param number.',
+                    23,
+                ],
+            ]
+        );
+    }
+
+    public static function getAdditionalConfigFiles(): array
+    {
+        return [
+            __DIR__ . '/../../../extension.neon',
+        ];
+    }
+}

tests/Rules/Symfony/url_generating_routes_with_requirements.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+    'someRoute1' => [[], ['_controller' => 'SomeController'], ['number' => '\\d+', 'date' => '\\d{4}-\\d{2}-\\d{2}'] /* ... */],
+    'someRoute2' => [[], ['_controller' => 'SomeController'], ['number' => '\\d+', 'date' => '\\d{4}-\\d{2}-\\d{2}'] /* ... */],
+    'someRoute3' => [[], ['_controller' => 'SomeController'], ['number' => '\\d+', 'date' => '\\d{4}-\\d{2}-\\d{2}'] /* ... */],
+];