symfony · nicolas-grekas · Dec 21, 2022 · Dec 7, 2022
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -7,6 +7,7 @@ CHANGELOG
  * Add `DomCrawlerAssertionsTrait::assertSelectorCount(int $count, string $selector)`
  * Allow to avoid `limit` definition in a RateLimiter configuration when using the `no_limit` policy
  * Add `--format` option to the `debug:config` command
+ * Add support to pass namespace wildcard in `framework.messenger.routing`
 
 6.2
 ---

diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -2159,7 +2159,11 @@ private function registerMessengerConfiguration(array $config, ContainerBuilder
 
         $messageToSendersMapping = [];
         foreach ($config['routing'] as $message => $messageConfiguration) {
-            if ('*' !== $message && !class_exists($message) && !interface_exists($message, false)) {
+            if ('*' !== $message && !class_exists($message) && !interface_exists($message, false) && !preg_match('/^(?:[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*+\\\\)++\*$/', $message)) {
+                if (str_contains($message, '*')) {
+                    throw new LogicException(sprintf('Invalid Messenger routing configuration: invalid namespace "%s" wildcard.', $message));
+                }
+
                 throw new LogicException(sprintf('Invalid Messenger routing configuration: class or interface "%s" not found.', $message));
             }
 

diff --git a/...mfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/messenger_routing.php b/...mfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/messenger_routing.php
@@ -15,6 +15,7 @@
             SecondMessage::class => [
                 'senders' => ['amqp', 'audit'],
             ],
+            'Symfony\*' => 'amqp',
             '*' => 'amqp',
         ],
         'transports' => [

diff --git a/...eworkBundle/Tests/DependencyInjection/Fixtures/php/messenger_routing_invalid_wildcard.php b/...eworkBundle/Tests/DependencyInjection/Fixtures/php/messenger_routing_invalid_wildcard.php
@@ -0,0 +1,17 @@
+<?php
+
+$container->loadFromExtension('framework', [
+    'http_method_override' => false,
+    'serializer' => true,
+    'messenger' => [
+        'serializer' => [
+            'default_serializer' => 'messenger.transport.symfony_serializer',
+        ],
+        'routing' => [
+            'Symfony\*\DummyMessage' => ['audit'],
+        ],
+        'transports' => [
+            'audit' => 'null://',
+        ],
+    ],
+]);
diff --git a/...mfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/messenger_routing.xml b/...mfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/messenger_routing.xml
@@ -20,6 +20,9 @@
             <framework:routing message-class="*">
                 <framework:sender service="amqp" />
             </framework:routing>
+            <framework:routing message-class="Symfony\*">
+                <framework:sender service="amqp" />
+            </framework:routing>
             <framework:transport name="amqp" dsn="amqp://localhost/%2f/messages" />
             <framework:transport name="audit" dsn="null://" />
         </framework:messenger>

diff --git a/...eworkBundle/Tests/DependencyInjection/Fixtures/xml/messenger_routing_invalid_wildcard.xml b/...eworkBundle/Tests/DependencyInjection/Fixtures/xml/messenger_routing_invalid_wildcard.xml
@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<container xmlns="http://symfony.com/schema/dic/services"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns:framework="http://symfony.com/schema/dic/symfony"
+    xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd
+        http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">
+
+    <framework:config http-method-override="false">
+        <framework:serializer enabled="true" />
+        <framework:messenger>
+            <framework:serializer default-serializer="messenger.transport.symfony_serializer" />
+            <framework:routing message-class="Symfony\*\DummyMessage">
+                <framework:sender service="audit" />
+            </framework:routing>
+            <framework:transport name="audit" dsn="null://" />
+        </framework:messenger>
+    </framework:config>
+</container>
diff --git a/...mfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/messenger_routing.yml b/...mfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/messenger_routing.yml
@@ -8,6 +8,8 @@ framework:
             'Symfony\Bundle\FrameworkBundle\Tests\Fixtures\Messenger\DummyMessage': [amqp, messenger.transport.audit]
             'Symfony\Bundle\FrameworkBundle\Tests\Fixtures\Messenger\SecondMessage':
                 senders: [amqp, audit]
+            'Symfony\Bundle\FrameworkBundle\Tests\Fixtures\Messenger\*': [amqp]
+            'Symfony\*': [amqp]
             '*': amqp
         transports:
             amqp: 'amqp://localhost/%2f/messages'

diff --git a/...eworkBundle/Tests/DependencyInjection/Fixtures/yml/messenger_routing_invalid_wildcard.yml b/...eworkBundle/Tests/DependencyInjection/Fixtures/yml/messenger_routing_invalid_wildcard.yml
@@ -0,0 +1,10 @@
+framework:
+    http_method_override: false
+    serializer: true
+    messenger:
+        serializer:
+            default_serializer: messenger.transport.symfony_serializer
+        routing:
+            'Symfony\*\DummyMessage': [audit]
+        transports:
+            audit: 'null://'
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php
@@ -1059,6 +1059,13 @@ public function testMessengerMiddlewareFactoryErroneousFormat()
     }
 
     public function testMessengerInvalidTransportRouting()
+    {
+        $this->expectException(\LogicException::class);
+        $this->expectExceptionMessage('Invalid Messenger routing configuration: invalid namespace "Symfony\*\DummyMessage" wildcard.');
+        $this->createContainerFromFile('messenger_routing_invalid_wildcard');
+    }
+
+    public function testMessengerInvalidWildcardRouting()
     {
         $this->expectException(\LogicException::class);
         $this->expectExceptionMessage('Invalid Messenger routing configuration: the "Symfony\Bundle\FrameworkBundle\Tests\Fixtures\Messenger\DummyMessage" class is being routed to a sender called "invalid". This is not a valid transport or service id.');

diff --git a/src/Symfony/Component/Messenger/CHANGELOG.md b/src/Symfony/Component/Messenger/CHANGELOG.md
@@ -4,6 +4,7 @@ CHANGELOG
 6.3
 ---
 
+ * Add support for namespace wildcards in the HandlersLocator to allow routing multiple messages within the same namespace
  * Deprecate `Symfony\Component\Messenger\Transport\InMemoryTransport` and
    `Symfony\Component\Messenger\Transport\InMemoryTransportFactory` in favor of
    `Symfony\Component\Messenger\Transport\InMemory\InMemoryTransport` and

diff --git a/src/Symfony/Component/Messenger/Handler/HandlersLocator.php b/src/Symfony/Component/Messenger/Handler/HandlersLocator.php
@@ -68,9 +68,22 @@ public static function listTypes(Envelope $envelope): array
         return [$class => $class]
             + class_parents($class)
             + class_implements($class)
+            + self::listWildcards($class)
             + ['*' => '*'];
     }
 
+    private static function listWildcards(string $type): array
+    {
+        $type .= '\*';
+        $wildcards = [];
+        while ($i = strrpos($type, '\\', -3)) {
+            $type = substr_replace($type, '\*', $i);
+            $wildcards[$type] = $type;
+        }
+
+        return $wildcards;
+    }
+
     private function shouldHandle(Envelope $envelope, HandlerDescriptor $handlerDescriptor): bool
     {
         if (null === $received = $envelope->last(ReceivedStamp::class)) {

diff --git a/src/Symfony/Component/Messenger/Tests/Handler/HandlersLocatorTest.php b/src/Symfony/Component/Messenger/Tests/Handler/HandlersLocatorTest.php
@@ -56,6 +56,29 @@ public function testItReturnsOnlyHandlersMatchingTransport()
             new Envelope(new DummyMessage('Body'), [new ReceivedStamp('transportName')])
         )));
     }
+
+    public function testItReturnsOnlyHandlersMatchingMessageNamespace()
+    {
+        $firstHandler = $this->createPartialMock(HandlersLocatorTestCallable::class, ['__invoke']);
+        $secondHandler = $this->createPartialMock(HandlersLocatorTestCallable::class, ['__invoke']);
+
+        $locator = new HandlersLocator([
+            str_replace('DummyMessage', '*', DummyMessage::class) => [
+                $first = new HandlerDescriptor($firstHandler, ['alias' => 'one']),
+            ],
+            str_replace('Fixtures\\DummyMessage', '*', DummyMessage::class) => [
+                $second = new HandlerDescriptor($secondHandler, ['alias' => 'two']),
+            ],
+        ]);
+
+        $first->getName();
+        $second->getName();
+
+        $this->assertEquals([
+            $first,
+            $second,
+        ], iterator_to_array($locator->getHandlers(new Envelope(new DummyMessage('Body')))));
+    }
 }
 
 class HandlersLocatorTestCallable