[symfony] Add NoRouteTrailingSlashPathRule (#176)

Author: TomasVotruba

README.md

@@ -885,6 +885,17 @@ class SomeController
 
 <br>
 
+### NoRouteTrailingSlashPathRule
+
+Avoid trailing slash in route path, to prevent redirects and SEO issues
+
+```yaml
+rules:
+    - Symplify\PHPStanRules\Rules\Symfony\NoRouteTrailingSlashPathRule
+```
+
+<br>
+
 ### RequireAttributeNamespaceRule
 
 Attribute must be located in "Attribute" namespace

config/symfony-rules.neon

@@ -10,6 +10,7 @@ rules:
     # routing
     - Symplify\PHPStanRules\Rules\Symfony\NoRoutingPrefixRule
     - Symplify\PHPStanRules\Rules\Symfony\NoClassLevelRouteRule
+    - Symplify\PHPStanRules\Rules\Symfony\NoRouteTrailingSlashPathRule
 
     # dependency injection
     - Symplify\PHPStanRules\Rules\Symfony\NoGetDoctrineInControllerRule

src/Enum/SymfonyRuleIdentifier.php

@@ -33,4 +33,6 @@ final class SymfonyRuleIdentifier
     public const NO_ROUTING_PREFIX = 'symfony.noRoutingPrefix';
 
     public const NO_CLASS_LEVEL_ROUTE = 'symfony.noClassLevelRoute';
+
+    public const NO_ROUTE_TRAILING_SLASH_PATH = 'symfony.noRouteTrailingSlashPath';
 }

src/Rules/Symfony/NoRouteTrailingSlashPathRule.php

@@ -0,0 +1,80 @@
+<?php
+
+namespace Symplify\PHPStanRules\Rules\Symfony;
+
+use PhpParser\Comment\Doc;
+use PhpParser\Node;
+use PhpParser\Node\Stmt\ClassMethod;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleError;
+use PHPStan\Rules\RuleErrorBuilder;
+use Symplify\PHPStanRules\Enum\SymfonyRuleIdentifier;
+use Symplify\PHPStanRules\Symfony\NodeAnalyzer\SymfonyControllerAnalyzer;
+
+/**
+ * @see \Symplify\PHPStanRules\Tests\Rules\Symfony\NoRouteTrailingSlashPathRule\NoRouteTrailingSlashPathRuleTest
+ *
+ * @implements Rule<ClassMethod>
+ */
+final class NoRouteTrailingSlashPathRule implements Rule
+{
+    /**
+     * @var string
+     */
+    public const ERROR_MESSAGE = 'Avoid trailing slash in route path "%s", to prevent redirects and SEO issues';
+
+    public function getNodeType(): string
+    {
+        return ClassMethod::class;
+    }
+
+    /**
+     * @param ClassMethod $node
+     * @return RuleError[]
+     */
+    public function processNode(Node $node, Scope $scope): array
+    {
+        if ($node->isMagic() || ! $node->isPublic()) {
+            return [];
+        }
+
+        if (! SymfonyControllerAnalyzer::isControllerScope($scope)) {
+            return [];
+        }
+
+        $routePath = $this->matchRouteDocblockPath($node);
+        if (! is_string($routePath)) {
+            return [];
+        }
+
+        // path is valid
+        if ($routePath === '/' || ! str_ends_with($routePath, '/')) {
+            return [];
+        }
+
+        $identifierRuleError = RuleErrorBuilder::message(sprintf(self::ERROR_MESSAGE, $routePath))
+            ->identifier(SymfonyRuleIdentifier::NO_ROUTE_TRAILING_SLASH_PATH)
+            ->build();
+
+        return [$identifierRuleError];
+    }
+
+    private function matchRouteDocblockPath(ClassMethod $classMethod): ?string
+    {
+        $docComment = $classMethod->getDocComment();
+        if (! $docComment instanceof Doc) {
+            return null;
+        }
+
+        // not a route
+        if (! str_contains($docComment->getText(), 'Route')) {
+            return null;
+        }
+
+        /** @see https://regex101.com/r/Qo7aLu/1 */
+        preg_match('#@Route\((path=)?"(?<path>[\/\w\-]+)"#', $docComment->getText(), $matches);
+
+        return $matches['path'] ?? null;
+    }
+}

tests/Rules/Symfony/NoRouteTrailingSlashPathRule/Fixture/CorrectController.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Tests\Rules\Symfony\NoRouteTrailingSlashPathRule\Fixture;
+
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\Routing\Annotation\Route;
+
+final class CorrectController extends AbstractController
+{
+    /**
+     * @Route("/some-route")
+     */
+    public function someAction()
+    {
+    }
+}

tests/Rules/Symfony/NoRouteTrailingSlashPathRule/Fixture/InvalidController.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Tests\Rules\Symfony\NoRouteTrailingSlashPathRule\Fixture;
+
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\Routing\Annotation\Route;
+
+final class InvalidController extends AbstractController
+{
+    /**
+     * @Route("/some-route/")
+     */
+    public function someAction()
+    {
+    }
+}

tests/Rules/Symfony/NoRouteTrailingSlashPathRule/Fixture/InvalidWithNameController.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Tests\Rules\Symfony\NoRouteTrailingSlashPathRule\Fixture;
+
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\Routing\Annotation\Route;
+
+final class InvalidWithNameController extends AbstractController
+{
+    /**
+     * @Route("/next-route/", name="more-text")
+     */
+    public function someAction()
+    {
+    }
+}

tests/Rules/Symfony/NoRouteTrailingSlashPathRule/Fixture/PathAwareInvalidController.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Tests\Rules\Symfony\NoRouteTrailingSlashPathRule\Fixture;
+
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\Routing\Annotation\Route;
+
+final class PathAwareInvalidController extends AbstractController
+{
+    /**
+     * @Route(path="/another-route/")
+     */
+    public function someAction()
+    {
+    }
+}

tests/Rules/Symfony/NoRouteTrailingSlashPathRule/Fixture/SoleSlashController.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Tests\Rules\Symfony\NoRouteTrailingSlashPathRule\Fixture;
+
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\Routing\Annotation\Route;
+
+final class SoleSlashController extends AbstractController
+{
+    /**
+     * @Route("/")
+     */
+    public function someAction()
+    {
+    }
+}

tests/Rules/Symfony/NoRouteTrailingSlashPathRule/NoRouteTrailingSlashPathRuleTest.php

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Tests\Rules\Symfony\NoRouteTrailingSlashPathRule;
+
+use Iterator;
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Symplify\PHPStanRules\Rules\Symfony\NoRouteTrailingSlashPathRule;
+
+final class NoRouteTrailingSlashPathRuleTest extends RuleTestCase
+{
+    /**
+     * @param mixed[] $expectedErrorsWithLines
+     */
+    #[DataProvider('provideData')]
+    public function testRule(string $filePath, array $expectedErrorsWithLines): void
+    {
+        $this->analyse([$filePath], $expectedErrorsWithLines);
+    }
+
+    public static function provideData(): Iterator
+    {
+        yield [__DIR__ . '/Fixture/SoleSlashController.php', []];
+        yield [__DIR__ . '/Fixture/CorrectController.php', []];
+
+        yield [
+            __DIR__ . '/Fixture/InvalidController.php',
+            [[sprintf(NoRouteTrailingSlashPathRule::ERROR_MESSAGE, '/some-route/'), 15]],
+        ];
+
+        yield [
+            __DIR__ . '/Fixture/InvalidWithNameController.php',
+            [[sprintf(NoRouteTrailingSlashPathRule::ERROR_MESSAGE, '/next-route/'), 15]],
+        ];
+
+        yield [
+            __DIR__ . '/Fixture/PathAwareInvalidController.php',
+            [[sprintf(NoRouteTrailingSlashPathRule::ERROR_MESSAGE, '/another-route/'), 15]],
+        ];
+    }
+
+    protected function getRule(): Rule
+    {
+        return new NoRouteTrailingSlashPathRule();
+    }
+}