bug symfony#47227 [Messenger] Support for custom handler method containing a Union type tagged with #[AsMessageHandler] (ArchitectNate)

This PR was squashed before being merged into the 6.1 branch.

Discussion
----------

[Messenger] Support for custom handler method containing a Union type tagged with #[AsMessageHandler]

| Q             | A
| ------------- | ---
| Branch?       | 6.1
| Bug fix?      | yes
| New feature?  | no
| Deprecations? | no
| Tickets       | Fix symfony#47206
| License       | MIT
| Doc PR        | No

When Union Types were implemented for the #[AsMessageHandler] attribute, it wasn't designed with non `__invoke` methods in mind.

This fix detects if we are using `__invoke` or not and constructs the return to match the rest of the logic, mainly it allows for a `type => methodName` map if `__invoke` is not being used.

Commits
-------

f38d8f8 [Messenger] Support for custom handler method containing a Union type tagged with #[AsMessageHandler]

Author: fabpot

src/Symfony/Component/Messenger/DependencyInjection/MessengerPass.php

@@ -231,7 +231,7 @@ private function guessHandledClasses(\ReflectionClass $handlerClass, string $ser
             }
 
             if ($types) {
-                return $types;
+                return ('__invoke' === $methodName) ? $types : array_fill_keys($types, $methodName);
             }
         }
 

src/Symfony/Component/Messenger/Tests/DependencyInjection/MessengerPassTest.php

@@ -49,6 +49,9 @@
 use Symfony\Component\Messenger\Tests\Fixtures\MultipleBusesMessageHandler;
 use Symfony\Component\Messenger\Tests\Fixtures\SecondMessage;
 use Symfony\Component\Messenger\Tests\Fixtures\TaggedDummyHandler;
+use Symfony\Component\Messenger\Tests\Fixtures\TaggedDummyHandlerWithUnionTypes;
+use Symfony\Component\Messenger\Tests\Fixtures\UnionTypeOneMessage;
+use Symfony\Component\Messenger\Tests\Fixtures\UnionTypeTwoMessage;
 use Symfony\Component\Messenger\Transport\Receiver\ReceiverInterface;
 
 class MessengerPassTest extends TestCase
@@ -180,6 +183,54 @@ public function testTaggedMessageHandler()
         );
     }
 
+    public function testTaggedMessageHandlerWithUnionTypes()
+    {
+        $container = $this->getContainerBuilder($busId = 'message_bus');
+        $container->registerAttributeForAutoconfiguration(AsMessageHandler::class, static function (ChildDefinition $definition, AsMessageHandler $attribute, \ReflectionClass|\ReflectionMethod $reflector): void {
+            $tagAttributes = get_object_vars($attribute);
+            $tagAttributes['from_transport'] = $tagAttributes['fromTransport'];
+            unset($tagAttributes['fromTransport']);
+            if ($reflector instanceof \ReflectionMethod) {
+                if (isset($tagAttributes['method'])) {
+                    throw new LogicException(sprintf('AsMessageHandler attribute cannot declare a method on "%s::%s()".', $reflector->class, $reflector->name));
+                }
+                $tagAttributes['method'] = $reflector->getName();
+            }
+
+            $definition->addTag('messenger.message_handler', $tagAttributes);
+        });
+        $container
+            ->register(TaggedDummyHandlerWithUnionTypes::class, TaggedDummyHandlerWithUnionTypes::class)
+            ->setAutoconfigured(true)
+        ;
+
+        (new AttributeAutoconfigurationPass())->process($container);
+        (new ResolveInstanceofConditionalsPass())->process($container);
+        (new MessengerPass())->process($container);
+
+        $handlersLocatorDefinition = $container->getDefinition($busId.'.messenger.handlers_locator');
+        $this->assertSame(HandlersLocator::class, $handlersLocatorDefinition->getClass());
+
+        $handlerDescriptionMapping = $handlersLocatorDefinition->getArgument(0);
+
+        $this->assertCount(4, $handlerDescriptionMapping);
+
+        $this->assertHandlerDescriptor($container, $handlerDescriptionMapping, DummyMessage::class, [TaggedDummyHandlerWithUnionTypes::class], [[]]);
+        $this->assertHandlerDescriptor($container, $handlerDescriptionMapping, SecondMessage::class, [TaggedDummyHandlerWithUnionTypes::class], [[]]);
+        $this->assertHandlerDescriptor(
+            $container,
+            $handlerDescriptionMapping,
+            UnionTypeOneMessage::class,
+            [[TaggedDummyHandlerWithUnionTypes::class, 'handleUnionTypeMessage']]
+        );
+        $this->assertHandlerDescriptor(
+            $container,
+            $handlerDescriptionMapping,
+            UnionTypeTwoMessage::class,
+            [[TaggedDummyHandlerWithUnionTypes::class, 'handleUnionTypeMessage']]
+        );
+    }
+
     public function testProcessHandlersByBus()
     {
         $container = $this->getContainerBuilder($commandBusId = 'command_bus');

src/Symfony/Component/Messenger/Tests/Fixtures/TaggedDummyHandlerWithUnionTypes.php

@@ -0,0 +1,27 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Messenger\Tests\Fixtures;
+
+use Symfony\Component\Messenger\Attribute\AsMessageHandler;
+
+#[AsMessageHandler]
+class TaggedDummyHandlerWithUnionTypes
+{
+    public function __invoke(DummyMessage|SecondMessage $message)
+    {
+    }
+
+    #[AsMessageHandler]
+    public function handleUnionTypeMessage(UnionTypeOneMessage|UnionTypeTwoMessage $message)
+    {
+    }
+}

src/Symfony/Component/Messenger/Tests/Fixtures/UnionTypeOneMessage.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Symfony\Component\Messenger\Tests\Fixtures;
+
+class UnionTypeOneMessage
+{
+}

src/Symfony/Component/Messenger/Tests/Fixtures/UnionTypeTwoMessage.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Symfony\Component\Messenger\Tests\Fixtures;
+
+class UnionTypeTwoMessage
+{
+}