feat: add NoSymfonySessionInConstructor rule and update rules configuration

Author: shyim

rules.neon

@@ -1,13 +1,14 @@
 rules:
     - Shopware\PhpStan\Rule\ClassExtendUsesAbstractClassWhenExisting
     - Shopware\PhpStan\Rule\DisallowDefaultContextCreation
-    - Shopware\PhpStan\Rule\ForbidGlobBraceRule
     - Shopware\PhpStan\Rule\DisallowFunctionsRule
+    - Shopware\PhpStan\Rule\ForbidGlobBraceRule
     - Shopware\PhpStan\Rule\InternalClassExtendsRule
     - Shopware\PhpStan\Rule\InternalFunctionCallRule
     - Shopware\PhpStan\Rule\InternalMethodCallRule
     - Shopware\PhpStan\Rule\MethodBecomesAbstractRule
-    - Shopware\PhpStan\Rule\NoUserEntityGetStoreTokenRule
+    - Shopware\PhpStan\Rule\NoDALFilterByID
+    - Shopware\PhpStan\Rule\NoSymfonySessionInConstructor
     - Shopware\PhpStan\Rule\NoUserEntityGetStoreTokenRule
     - Shopware\PhpStan\Rule\ScheduledTaskTooLowIntervalRule
     - Shopware\PhpStan\Rule\SetForeignKeyRule

src/Rule/NoSymfonySessionInConstructorRule.php

@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopware\PhpStan\Rule;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\MethodCall;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use PHPStan\Type\ObjectType;
+
+/**
+ * @implements Rule<MethodCall>
+ */
+class NoSymfonySessionInConstructorRule implements Rule
+{
+    public function getNodeType(): string
+    {
+        return MethodCall::class;
+    }
+
+    public function processNode(Node $node, Scope $scope): array
+    {
+        if ($scope->getFunctionName() !== '__construct') {
+            return [];
+        }
+
+        $objectType = $scope->getType($node->var);
+
+        $sessionInterfaceType = new ObjectType(
+            'Symfony\\Component\\HttpFoundation\\Session\\SessionInterface',
+        );
+
+        if ($objectType->isSuperTypeOf($sessionInterfaceType)->maybe()) {
+            return [
+                RuleErrorBuilder::message(
+                    'Symfony Session should not be called in constructor. Consider using it in the method where it\'s needed.',
+                )
+                    ->identifier('shopware.sessionUsageInConstructor')
+                    ->build(),
+            ];
+        }
+
+        return [];
+    }
+}

tests/Rule/NoSymfonySessionInConstructorTest.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopware\PhpStan\Tests\Rule;
+
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+use Shopware\PhpStan\Rule\NoSymfonySessionInConstructorRule;
+
+/**
+ * @extends RuleTestCase<NoSymfonySessionInConstructorRule>
+ */
+class NoSymfonySessionInConstructorTest extends RuleTestCase
+{
+    protected function getRule(): Rule
+    {
+        return new NoSymfonySessionInConstructorRule();
+    }
+
+    public function testRule(): void
+    {
+        $this->analyse([__DIR__ . '/../data/NoSymfonySessionInConstructorRule/NoSymfonySessionInConstructor.php'], [
+            [
+                'Symfony Session should not be called in constructor. Consider using it in the method where it\'s needed.',
+                16,
+            ],
+        ]);
+    }
+}

tests/data/NoSymfonySessionInConstructorRule/NoSymfonySessionInConstructor.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace YourNamespace\Tests\Rule\Data;
+
+use Symfony\Component\HttpFoundation\Session\Session;
+
+class ClassWithSessionInConstructor
+{
+    private Session $session;
+
+    public function __construct(
+        Session $session,
+    ) {
+        $session->get('test');
+    }
+}
+
+class ClassSessionInMethod
+{
+    public function __construct(
+        private Session $session,
+    ) {}
+
+    public function someMethod(): void
+    {
+        $this->session->get('test');
+    }
+}