NEXT-37352 - Introduce phpat

.danger.php

@@ -17,8 +17,9 @@
     ],
     'strict' => [
         '^phpstan\/phpstan.*$' => 'Even patch updates for PHPStan may lead to a red CI pipeline, because of new static analysis errors',
-        '^symplify\/phpstan-rules$'  => 'Even patch updates for PHPStan may lead to a red CI pipeline, because of new static analysis errors',
-        '^rector\/type-perfect$'  => 'Even patch updates for PHPStan may lead to a red CI pipeline, because of new static analysis errors',
+        '^symplify\/phpstan-rules$'  => 'Even patch updates for PHPStan plugins may lead to a red CI pipeline, because of new static analysis errors',
+        '^rector\/type-perfect$'  => 'Even patch updates for PHPStan plugins may lead to a red CI pipeline, because of new static analysis errors',
+        '^phpat\/phpat$'  => 'Even patch updates for PHPStan plugins may lead to a red CI pipeline, because of new static analysis errors',
         '^dompdf\/dompdf$' => 'Patch updates of dompdf have let to a lot of issues in the past, therefore it is pinned.',
         '^scssphp\/scssphp$' => 'Patch updates of scssphp might lead to UI breaks, therefore it is pinned.',
         '^shopware\/conflicts$' => 'The shopware conflicts packages should be required in any version, so use `*` constraint',

composer.json

@@ -170,6 +170,7 @@
         "league/flysystem-google-cloud-storage": "^3.10.3",
         "nikic/php-parser": "^4.16.0",
         "opis/json-schema": "^2.3.0",
+        "phpat/phpat": "0.10.18",
         "phpbench/phpbench": "^1.2.15",
         "phpdocumentor/reflection-docblock": "^5.3.0",
         "phpdocumentor/type-resolver": "^1.7.1",

phpstan.neon.dist

@@ -312,6 +312,14 @@ services:
     - # register the class, so we can decorate it, but don't tag it as a rule, so only our decorator is used by PHPStan
         class: Symplify\PHPStanRules\Rules\NoReturnSetterMethodRule
 
+    -
+        class: Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\MessageHandlerFinalRule
+        tags:
+            - phpat.test
+    -
+        class: Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\NotExtendFlowEventAwareRule
+        tags:
+            - phpat.test
 rules:
     # rules from https://github.com/symplify/phpstan-rules
     # domain

src/Core/DevOps/StaticAnalyze/PHPStan/Rules/Deprecation/DeprecatedMethodsThrowDeprecationRule.php

@@ -34,6 +34,8 @@ class DeprecatedMethodsThrowDeprecationRule implements Rule
         'reason:remove-entity',
         // Only the route on controller will be removed
         'reason:remove-route',
+        // Throwing deprecations in PHPStan rules would cause problems while executed
+        'reason:remove-phpstan-rule',
         // Classes that will be internal are still called from inside the core, therefore they do not trigger deprecations.
         'reason:becomes-internal',
         // New function parameter will be added

src/Core/DevOps/StaticAnalyze/PHPStan/Rules/FinalClassRule.php

@@ -11,6 +11,8 @@
 use Symfony\Component\Messenger\Attribute\AsMessageHandler;
 
 /**
+ * @deprecated tag:v6.7.0 - reason:remove-phpstan-rule - Will be removed. Configure Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\MessageHandlerFinalRule instead
+ *
  * @implements Rule<InClassNode>
  *
  * @internal

src/Core/DevOps/StaticAnalyze/PHPStan/Rules/MessageHandlerFinalRule.php

@@ -0,0 +1,25 @@
+<?php declare(strict_types=1);
+
+namespace Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules;
+
+use PHPat\Selector\Selector;
+use PHPat\Test\Attributes\TestRule;
+use PHPat\Test\Builder\Rule;
+use PHPat\Test\PHPat;
+use Shopware\Core\Framework\Log\Package;
+use Symfony\Component\Messenger\Attribute\AsMessageHandler;
+
+/**
+ * @internal
+ */
+#[Package('core')]
+class MessageHandlerFinalRule
+{
+    #[TestRule]
+    public function isMessageHandlerFinal(): Rule
+    {
+        return PHPat::rule()
+            ->classes(Selector::appliesAttribute(AsMessageHandler::class))
+            ->shouldBeFinal();
+    }
+}

src/Core/DevOps/StaticAnalyze/PHPStan/Rules/NoFlowEventAwareExtendsRule.php

@@ -13,6 +13,8 @@
 use Shopware\Core\Framework\Log\Package;
 
 /**
+ * @deprecated tag:v6.7.0 - reason:remove-phpstan-rule - Will be removed. Configure Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\NotExtendFlowEventAwareRule instead
+ *
  * @implements Rule<InClassNode>
  *
  * @internal

src/Core/DevOps/StaticAnalyze/PHPStan/Rules/NotExtendFlowEventAwareRule.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules;
+
+use PHPat\Selector\Selector;
+use PHPat\Test\Attributes\TestRule;
+use PHPat\Test\Builder\Rule;
+use PHPat\Test\PHPat;
+use Shopware\Core\Framework\Event\FlowEventAware;
+use Shopware\Core\Framework\Log\Package;
+
+/**
+ * @internal
+ */
+#[Package('core')]
+class NotExtendFlowEventAwareRule
+{
+    #[TestRule]
+    public function doNotExtendFlowEventAware(): Rule
+    {
+        return PHPat::rule()
+            ->classes(Selector::isInterface())
+            ->shouldNotDependOn()
+            ->classes(Selector::classname(FlowEventAware::class));
+    }
+}

src/Core/DevOps/StaticAnalyze/PHPStan/core-rules.neon

@@ -4,7 +4,7 @@ rules:
     - Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\Internal\InternalMethodRule
     - Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\Tests\CoversAttributeRule
     - Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\Tests\MockingSimpleObjectsNotAllowedRule
-    - Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\FinalClassRule
+    - Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\FinalClassRule # @deprecated tag:v6.7.0 - Configure \Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\MessageHandlerFinalRule instead
     - Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\AbstractClassUsageRule
     - Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\DecorationPatternRule
     - Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\AddColumnRule

src/Core/DevOps/StaticAnalyze/PHPStan/rules.neon

@@ -5,7 +5,7 @@ rules:
     - Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\RuleAreasFlagNotAllowedRule
     - Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\RuleConditionHasRuleConfigRule
     - Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\Tests\NoAssertsOnObjectsRule
-    - Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\NoFlowEventAwareExtendsRule
+    - Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\NoFlowEventAwareExtendsRule # @deprecated tag:v6.7.0 - Configure \Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\NotExtendFlowEventAwareRule instead
     - Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\NoFlowStoreFunctionRule
     - Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\NoEnvironmentHelperInsideCompilerPassRule
     - Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\NoSuperGlobalsInsideCompilerPassRule