bug #58594 [Messenger] Check for #[AsMessage] attributes on parents (HypeMC)

This PR was merged into the 7.2 branch.

Discussion
----------

[Messenger] Check for `#[AsMessage]` attributes on parents

| Q             | A
| ------------- | ---
| Branch?       | 7.2
| Bug fix?      | no
| New feature?  | no
| Deprecations? | no
| Issues        | -
| License       | MIT

I've been testing the `#[AsMessage]` attribute and noticed that the attribute is not being read from parent classes or interfaces. This is different to how the `routing` option works, so currently, attributes can't fully replace the option.

Commits
-------

a164474fe36 [Messenger] Check for `#[AsMessage]` attributes on parents

Author: nicolas-grekas

Tests/Fixtures/DummyMessageInterfaceWithAttribute1.php

@@ -0,0 +1,19 @@
+<?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\AsMessage;
+
+#[AsMessage(transport: ['first_sender', 'third_sender'])]
+interface DummyMessageInterfaceWithAttribute1
+{
+}

Tests/Fixtures/DummyMessageInterfaceWithAttribute2.php

@@ -0,0 +1,19 @@
+<?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\AsMessage;
+
+#[AsMessage(transport: 'second_sender')]
+interface DummyMessageInterfaceWithAttribute2
+{
+}

Tests/Fixtures/DummyMessageWithInterfaceWithAttribute.php

@@ -0,0 +1,25 @@
+<?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;
+
+class DummyMessageWithInterfaceWithAttribute implements DummyMessageInterfaceWithAttribute1, DummyMessageInterfaceWithAttribute2
+{
+    public function __construct(
+        private string $message,
+    ) {
+    }
+
+    public function getMessage(): string
+    {
+        return $this->message;
+    }
+}

Tests/Fixtures/DummyMessageWithParentWithAttribute.php

@@ -0,0 +1,19 @@
+<?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\AsMessage;
+
+#[AsMessage(transport: 'third_sender')]
+class DummyMessageWithParentWithAttribute extends DummyMessageWithAttribute
+{
+}

Tests/Transport/Sender/SendersLocatorTest.php

@@ -55,19 +55,26 @@ public function testItReturnsTheSenderBasedOnTransportNamesStamp()
         $this->assertSame([], iterator_to_array($locator->getSenders(new Envelope(new SecondMessage()))));
     }
 
-    public function testItReturnsTheSenderBasedOnAsMessageAttribute()
+    /**
+     * @testWith ["\\Symfony\\Component\\Messenger\\Tests\\Fixtures\\DummyMessageWithAttribute", ["first_sender", "second_sender"]]
+     *           ["\\Symfony\\Component\\Messenger\\Tests\\Fixtures\\DummyMessageWithParentWithAttribute", ["third_sender", "first_sender", "second_sender"]]
+     *           ["\\Symfony\\Component\\Messenger\\Tests\\Fixtures\\DummyMessageWithInterfaceWithAttribute", ["first_sender", "third_sender", "second_sender"]]
+     */
+    public function testItReturnsTheSenderBasedOnAsMessageAttribute(string $messageClass, array $expectedSenders)
     {
         $firstSender = $this->createMock(SenderInterface::class);
         $secondSender = $this->createMock(SenderInterface::class);
+        $thirdSender = $this->createMock(SenderInterface::class);
         $otherSender = $this->createMock(SenderInterface::class);
         $sendersLocator = $this->createContainer([
             'first_sender' => $firstSender,
             'second_sender' => $secondSender,
+            'third_sender' => $thirdSender,
             'other_sender' => $otherSender,
         ]);
         $locator = new SendersLocator([], $sendersLocator);
 
-        $this->assertSame(['first_sender' => $firstSender, 'second_sender' => $secondSender], iterator_to_array($locator->getSenders(new Envelope(new DummyMessageWithAttribute('a')))));
+        $this->assertSame($expectedSenders, array_keys(iterator_to_array($locator->getSenders(new Envelope(new $messageClass('a'))))));
         $this->assertSame([], iterator_to_array($locator->getSenders(new Envelope(new SecondMessage()))));
     }
 

Transport/Sender/SendersLocator.php

@@ -80,13 +80,15 @@ public function getSenders(Envelope $envelope): iterable
     private function getTransportNamesFromAttribute(Envelope $envelope): array
     {
         $transports = [];
-        $message = $envelope->getMessage();
+        $messageClass = $envelope->getMessage()::class;
 
-        foreach ((new \ReflectionClass($message))->getAttributes(AsMessage::class, \ReflectionAttribute::IS_INSTANCEOF) as $refAttr) {
-            $asMessage = $refAttr->newInstance();
+        foreach ([$messageClass] + class_parents($messageClass) + class_implements($messageClass) as $class) {
+            foreach ((new \ReflectionClass($class))->getAttributes(AsMessage::class, \ReflectionAttribute::IS_INSTANCEOF) as $refAttr) {
+                $asMessage = $refAttr->newInstance();
 
-            if ($asMessage->transport) {
-                $transports = \array_merge($transports, (array) $asMessage->transport);
+                if ($asMessage->transport) {
+                    $transports = array_merge($transports, (array) $asMessage->transport);
+                }
             }
         }