[symfony 6.2] Fix attribute adding on abstract class in MessageHandlerInterfaceToAttributeRector

Author: TomasVotruba

rules-tests/Symfony62/Rector/Class_/MessageHandlerInterfaceToAttributeRector/Fixture/class_that_extends_abstact_class_that_implements_handler.php.inc

@@ -0,0 +1,24 @@
+<?php
+
+namespace Rector\Symfony\Tests\Symfony62\Rector\Class_\MessageHandlerInterfaceToAttributeRector\Fixture;
+
+use Rector\Symfony\Tests\Symfony62\Rector\Class_\MessageHandlerInterfaceToAttributeRector\Source\AbstractClassWithHandlerInterface;
+
+class ClassThatExtendsAbstractClassThatImplementsHandler extends AbstractClassWithHandlerInterface
+{
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Symfony\Tests\Symfony62\Rector\Class_\MessageHandlerInterfaceToAttributeRector\Fixture;
+
+use Rector\Symfony\Tests\Symfony62\Rector\Class_\MessageHandlerInterfaceToAttributeRector\Source\AbstractClassWithHandlerInterface;
+
+#[\Symfony\Component\Messenger\Attribute\AsMessageHandler]
+class ClassThatExtendsAbstractClassThatImplementsHandler extends AbstractClassWithHandlerInterface
+{
+}
+
+?>

rules-tests/Symfony62/Rector/Class_/MessageHandlerInterfaceToAttributeRector/Fixture/only_remove_interface_from_abstract_class.php.inc

@@ -0,0 +1,23 @@
+<?php
+
+namespace Rector\Symfony\Tests\Symfony62\Rector\Class_\MessageHandlerInterfaceToAttributeRector\Fixture;
+
+use Symfony\Component\Messenger\Handler\MessageHandlerInterface;
+
+abstract class OnlyRemoveInterfaceFromAbstactClass implements MessageHandlerInterface
+{
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Symfony\Tests\Symfony62\Rector\Class_\MessageHandlerInterfaceToAttributeRector\Fixture;
+
+use Symfony\Component\Messenger\Handler\MessageHandlerInterface;
+
+abstract class OnlyRemoveInterfaceFromAbstactClass
+{
+}
+
+?>

rules-tests/Symfony62/Rector/Class_/MessageHandlerInterfaceToAttributeRector/Source/AbstractClassWithHandlerInterface.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Rector\Symfony\Tests\Symfony62\Rector\Class_\MessageHandlerInterfaceToAttributeRector\Source;
+
+use Symfony\Component\Messenger\Handler\MessageHandlerInterface;
+
+abstract class AbstractClassWithHandlerInterface implements MessageHandlerInterface
+{
+}

rules/Symfony62/Rector/Class_/MessageHandlerInterfaceToAttributeRector.php

@@ -6,10 +6,11 @@
 
 use PhpParser\Node;
 use PhpParser\Node\Stmt\Class_;
+use PHPStan\Reflection\ReflectionProvider;
+use PHPStan\Type\ObjectType;
 use Rector\Php80\NodeAnalyzer\PhpAttributeAnalyzer;
 use Rector\Rector\AbstractRector;
 use Rector\Symfony\Helper\MessengerHelper;
-use Rector\Symfony\NodeAnalyzer\ClassAnalyzer;
 use Rector\Symfony\NodeManipulator\ClassManipulator;
 use Rector\Symfony\ValueObject\ServiceDefinition;
 use Rector\ValueObject\PhpVersionFeature;
@@ -25,8 +26,8 @@ final class MessageHandlerInterfaceToAttributeRector extends AbstractRector impl
     public function __construct(
         private readonly MessengerHelper $messengerHelper,
         private readonly ClassManipulator $classManipulator,
-        private readonly ClassAnalyzer $classAnalyzer,
         private readonly PhpAttributeAnalyzer $phpAttributeAnalyzer,
+        private readonly ReflectionProvider $reflectionProvider
     ) {
     }
 
@@ -84,11 +85,19 @@ public function getNodeTypes(): array
      */
     public function refactor(Node $node): ?Node
     {
+        if (! $this->reflectionProvider->hasClass(MessengerHelper::AS_MESSAGE_HANDLER_ATTRIBUTE)) {
+            return null;
+        }
+
         if ($this->phpAttributeAnalyzer->hasPhpAttribute($node, MessengerHelper::AS_MESSAGE_HANDLER_ATTRIBUTE)) {
             return null;
         }
 
-        if (! $this->classAnalyzer->hasImplements($node, MessengerHelper::MESSAGE_HANDLER_INTERFACE)) {
+        $classType = $this->getType($node);
+
+        $messageHandlerObjectType = new ObjectType(MessengerHelper::MESSAGE_HANDLER_INTERFACE);
+
+        if (! $messageHandlerObjectType->isSuperTypeOf($classType)->yes()) {
             $handlers = $this->messengerHelper->getHandlersFromServices();
             if ($handlers === []) {
                 return null;
@@ -99,6 +108,11 @@ public function refactor(Node $node): ?Node
 
         $this->classManipulator->removeImplements($node, [MessengerHelper::MESSAGE_HANDLER_INTERFACE]);
 
+        // no need to add the attribute
+        if ($node->isAbstract()) {
+            return $node;
+        }
+
         return $this->messengerHelper->addAttribute($node);
     }
 

src/Helper/MessengerHelper.php

@@ -24,6 +24,11 @@ final class MessengerHelper
 
     private string $messengerTagName = 'messenger.message_handler';
 
+    /**
+     * @var ServiceDefinition[]
+     */
+    private array $handlersFromServices = [];
+
     public function __construct(
         private readonly PhpAttributeGroupFactory $phpAttributeGroupFactory,
         private readonly AttributeArrayNameInliner $attributeArrayNameInliner,
@@ -42,6 +47,7 @@ public function extractOptionsFromServiceDefinition(ServiceDefinition $serviceDe
                 $options = $tag->getData();
             }
         }
+
         if ($options['from_transport']) {
             $options['fromTransport'] = $options['from_transport'];
             unset($options['from_transport']);
@@ -54,8 +60,15 @@ public function extractOptionsFromServiceDefinition(ServiceDefinition $serviceDe
      */
     public function getHandlersFromServices(): array
     {
+        if ($this->handlersFromServices !== []) {
+            return $this->handlersFromServices;
+        }
+
         $serviceMap = $this->serviceMapProvider->provide();
-        return $serviceMap->getServicesByTag($this->messengerTagName);
+
+        $this->handlersFromServices = $serviceMap->getServicesByTag($this->messengerTagName);
+
+        return $this->handlersFromServices;
     }
 
     /**

stubs/Symfony/Component/Messenger/Attribute/AsMessageHandler.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Symfony\Component\Messenger\Attribute;
+
+#[\Attribute(\Attribute::TARGET_CLASS)]
+class AsMessageHandler
+{
+}

stubs/Symfony/Component/Messenger/Handler/MessageHandlerInterface.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Symfony\Component\Messenger\Handler;
+
+interface MessageHandlerInterface
+{
+}