vendor/symfony/messenger/DependencyInjection/MessengerPass.php line 135

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Messenger\DependencyInjection;
  14. use Symfony\Component\DependencyInjection\Argument\IteratorArgument;
  15. use Symfony\Component\DependencyInjection\ChildDefinition;
  16. use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
  17. use Symfony\Component\DependencyInjection\Compiler\ServiceLocatorTagPass;
  18. use Symfony\Component\DependencyInjection\ContainerBuilder;
  19. use Symfony\Component\DependencyInjection\Definition;
  20. use Symfony\Component\DependencyInjection\Exception\OutOfBoundsException;
  21. use Symfony\Component\DependencyInjection\Exception\RuntimeException;
  22. use Symfony\Component\DependencyInjection\Reference;
  23. use Symfony\Component\Messenger\Handler\HandlerDescriptor;
  24. use Symfony\Component\Messenger\Handler\HandlersLocator;
  25. use Symfony\Component\Messenger\Handler\MessageSubscriberInterface;
  26. use Symfony\Component\Messenger\TraceableMessageBus;
  27. use Symfony\Component\Messenger\Transport\Receiver\ReceiverInterface;
  29. /**
  30.  * @author Samuel Roze <samuel.roze@gmail.com>
  31.  */
  32. class MessengerPass implements CompilerPassInterface
  33. {
  34.     private $handlerTag;
  35.     private $busTag;
  36.     private $receiverTag;
  38.     public function __construct(string $handlerTag = 'messenger.message_handler', string $busTag = 'messenger.bus', string $receiverTag = 'messenger.receiver')
  39.     {
  40.         if (0 < \func_num_args()) {
  41.             trigger_deprecation('symfony/messenger', '5.3', 'Configuring "%s" is deprecated.', __CLASS__);
  42.         }
  44.         $this->handlerTag = $handlerTag;
  45.         $this->busTag = $busTag;
  46.         $this->receiverTag = $receiverTag;
  47.     }
  49.     /**
  50.      * {@inheritdoc}
  51.      */
  52.     public function process(ContainerBuilder $container)
  53.     {
  54.         $busIds = [];
  55.         foreach ($container->findTaggedServiceIds($this->busTag) as $busId => $tags) {
  56.             $busIds[] = $busId;
  57.             if ($container->hasParameter($busMiddlewareParameter = $busId.'.middleware')) {
  58.                 $this->registerBusMiddleware($container, $busId, $container->getParameter($busMiddlewareParameter));
  60.                 $container->getParameterBag()->remove($busMiddlewareParameter);
  61.             }
  63.             if ($container->hasDefinition('data_collector.messenger')) {
  64.                 $this->registerBusToCollector($container, $busId);
  65.             }
  66.         }
  68.         if ($container->hasDefinition('messenger.receiver_locator')) {
  69.             $this->registerReceivers($container, $busIds);
  70.         }
  71.         $this->registerHandlers($container, $busIds);
  72.     }
  74.     private function registerHandlers(ContainerBuilder $container, array $busIds)
  75.     {
  76.         $definitions = [];
  77.         $handlersByBusAndMessage = [];
  78.         $handlerToOriginalServiceIdMapping = [];
  80.         foreach ($container->findTaggedServiceIds($this->handlerTag, true) as $serviceId => $tags) {
  81.             foreach ($tags as $tag) {
  82.                 if (isset($tag['bus']) && !\in_array($tag['bus'], $busIds, true)) {
  83.                     throw new RuntimeException(sprintf('Invalid handler service "%s": bus "%s" specified on the tag "%s" does not exist (known ones are: "%s").', $serviceId, $tag['bus'], $this->handlerTag, implode('", "', $busIds)));
  84.                 }
  86.                 $className = $this->getServiceClass($container, $serviceId);
  87.                 $r = $container->getReflectionClass($className);
  89.                 if (null === $r) {
  90.                     throw new RuntimeException(sprintf('Invalid service "%s": class "%s" does not exist.', $serviceId, $className));
  91.                 }
  93.                 if (isset($tag['handles'])) {
  94.                     $handles = isset($tag['method']) ? [$tag['handles'] => $tag['method']] : [$tag['handles']];
  95.                 } else {
  96.                     $handles = $this->guessHandledClasses($r, $serviceId);
  97.                 }
  99.                 $message = null;
  100.                 $handlerBuses = (array) ($tag['bus'] ?? $busIds);
  102.                 foreach ($handles as $message => $options) {
  103.                     $buses = $handlerBuses;
  105.                     if (\is_int($message)) {
  106.                         if (\is_string($options)) {
  107.                             $message = $options;
  108.                             $options = [];
  109.                         } else {
  110.                             throw new RuntimeException(sprintf('The handler configuration needs to return an array of messages or an associated array of message and configuration. Found value of type "%s" at position "%d" for service "%s".', get_debug_type($options), $message, $serviceId));
  111.                         }
  112.                     }
  114.                     if (\is_string($options)) {
  115.                         $options = ['method' => $options];
  116.                     }
  118.                     if (!isset($options['from_transport']) && isset($tag['from_transport'])) {
  119.                         $options['from_transport'] = $tag['from_transport'];
  120.                     }
  122.                     $priority = $tag['priority'] ?? $options['priority'] ?? 0;
  123.                     $method = $options['method'] ?? '__invoke';
  125.                     if (isset($options['bus'])) {
  126.                         if (!\in_array($options['bus'], $busIds)) {
  127.                             $messageLocation = isset($tag['handles']) ? 'declared in your tag attribute "handles"' : ($r->implementsInterface(MessageSubscriberInterface::class) ? sprintf('returned by method "%s::getHandledMessages()"', $r->getName()) : sprintf('used as argument type in method "%s::%s()"', $r->getName(), $method));
  129.                             throw new RuntimeException(sprintf('Invalid configuration "%s" for message "%s": bus "%s" does not exist.', $messageLocation, $message, $options['bus']));
  130.                         }
  132.                         $buses = [$options['bus']];
  133.                     }
  135.                     if ('*' !== $message && !class_exists($message) && !interface_exists($message, false)) {
  136.                         $messageLocation = isset($tag['handles']) ? 'declared in your tag attribute "handles"' : ($r->implementsInterface(MessageSubscriberInterface::class) ? sprintf('returned by method "%s::getHandledMessages()"', $r->getName()) : sprintf('used as argument type in method "%s::%s()"', $r->getName(), $method));
  138.                         throw new RuntimeException(sprintf('Invalid handler service "%s": class or interface "%s" "%s" not found.', $serviceId, $message, $messageLocation));
  139.                     }
  141.                     if (!$r->hasMethod($method)) {
  142.                         throw new RuntimeException(sprintf('Invalid handler service "%s": method "%s::%s()" does not exist.', $serviceId, $r->getName(), $method));
  143.                     }
  145.                     if ('__invoke' !== $method) {
  146.                         $wrapperDefinition = (new Definition('callable'))->addArgument([new Reference($serviceId), $method])->setFactory('Closure::fromCallable');
  148.                         $definitions[$definitionId = '.messenger.method_on_object_wrapper.'.ContainerBuilder::hash($message.':'.$priority.':'.$serviceId.':'.$method)] = $wrapperDefinition;
  149.                     } else {
  150.                         $definitionId = $serviceId;
  151.                     }
  153.                     $handlerToOriginalServiceIdMapping[$definitionId] = $serviceId;
  155.                     foreach ($buses as $handlerBus) {
  156.                         $handlersByBusAndMessage[$handlerBus][$message][$priority][] = [$definitionId, $options];
  157.                     }
  158.                 }
  160.                 if (null === $message) {
  161.                     throw new RuntimeException(sprintf('Invalid handler service "%s": method "%s::getHandledMessages()" must return one or more messages.', $serviceId, $r->getName()));
  162.                 }
  163.             }
  164.         }
  166.         foreach ($handlersByBusAndMessage as $bus => $handlersByMessage) {
  167.             foreach ($handlersByMessage as $message => $handlersByPriority) {
  168.                 krsort($handlersByPriority);
  169.                 $handlersByBusAndMessage[$bus][$message] = array_merge(...$handlersByPriority);
  170.             }
  171.         }
  173.         $handlersLocatorMappingByBus = [];
  174.         foreach ($handlersByBusAndMessage as $bus => $handlersByMessage) {
  175.             foreach ($handlersByMessage as $message => $handlers) {
  176.                 $handlerDescriptors = [];
  177.                 foreach ($handlers as $handler) {
  178.                     $definitions[$definitionId = '.messenger.handler_descriptor.'.ContainerBuilder::hash($bus.':'.$message.':'.$handler[0])] = (new Definition(HandlerDescriptor::class))->setArguments([new Reference($handler[0]), $handler[1]]);
  179.                     $handlerDescriptors[] = new Reference($definitionId);
  180.                 }
  182.                 $handlersLocatorMappingByBus[$bus][$message] = new IteratorArgument($handlerDescriptors);
  183.             }
  184.         }
  185.         $container->addDefinitions($definitions);
  187.         foreach ($busIds as $bus) {
  188.             $container->register($locatorId = $bus.'.messenger.handlers_locator', HandlersLocator::class)
  189.                 ->setArgument(0, $handlersLocatorMappingByBus[$bus] ?? [])
  190.             ;
  191.             if ($container->has($handleMessageId = $bus.'.middleware.handle_message')) {
  192.                 $container->getDefinition($handleMessageId)
  193.                     ->replaceArgument(0, new Reference($locatorId))
  194.                 ;
  195.             }
  196.         }
  198.         if ($container->hasDefinition('console.command.messenger_debug')) {
  199.             $debugCommandMapping = $handlersByBusAndMessage;
  200.             foreach ($busIds as $bus) {
  201.                 if (!isset($debugCommandMapping[$bus])) {
  202.                     $debugCommandMapping[$bus] = [];
  203.                 }
  205.                 foreach ($debugCommandMapping[$bus] as $message => $handlers) {
  206.                     foreach ($handlers as $key => $handler) {
  207.                         $debugCommandMapping[$bus][$message][$key][0] = $handlerToOriginalServiceIdMapping[$handler[0]];
  208.                     }
  209.                 }
  210.             }
  211.             $container->getDefinition('console.command.messenger_debug')->replaceArgument(0, $debugCommandMapping);
  212.         }
  213.     }
  215.     private function guessHandledClasses(\ReflectionClass $handlerClass, string $serviceId): iterable
  216.     {
  217.         if ($handlerClass->implementsInterface(MessageSubscriberInterface::class)) {
  218.             return $handlerClass->getName()::getHandledMessages();
  219.         }
  221.         try {
  222.             $method = $handlerClass->getMethod('__invoke');
  223.         } catch (\ReflectionException $e) {
  224.             throw new RuntimeException(sprintf('Invalid handler service "%s": class "%s" must have an "__invoke()" method.', $serviceId, $handlerClass->getName()));
  225.         }
  227.         if (0 === $method->getNumberOfRequiredParameters()) {
  228.             throw new RuntimeException(sprintf('Invalid handler service "%s": method "%s::__invoke()" requires at least one argument, first one being the message it handles.', $serviceId, $handlerClass->getName()));
  229.         }
  231.         $parameters = $method->getParameters();
  232.         if (!$type = $parameters[0]->getType()) {
  233.             throw new RuntimeException(sprintf('Invalid handler service "%s": argument "$%s" of method "%s::__invoke()" must have a type-hint corresponding to the message class it handles.', $serviceId, $parameters[0]->getName(), $handlerClass->getName()));
  234.         }
  236.         if ($type instanceof \ReflectionUnionType) {
  237.             $types = [];
  238.             foreach ($type->getTypes() as $type) {
  239.                 if (!$type->isBuiltin()) {
  240.                     $types[] = (string) $type;
  241.                 }
  242.             }
  244.             if ($types) {
  245.                 return $types;
  246.             }
  247.         }
  249.         if ($type->isBuiltin()) {
  250.             throw new RuntimeException(sprintf('Invalid handler service "%s": type-hint of argument "$%s" in method "%s::__invoke()" must be a class , "%s" given.', $serviceId, $parameters[0]->getName(), $handlerClass->getName(), $type instanceof \ReflectionNamedType ? $type->getName() : (string) $type));
  251.         }
  253.         return [$type->getName()];
  254.     }
  256.     private function registerReceivers(ContainerBuilder $container, array $busIds)
  257.     {
  258.         $receiverMapping = [];
  259.         $failureTransportsMap = [];
  260.         if ($container->hasDefinition('console.command.messenger_failed_messages_retry')) {
  261.             $commandDefinition = $container->getDefinition('console.command.messenger_failed_messages_retry');
  262.             $globalReceiverName = $commandDefinition->getArgument(0);
  263.             if (null !== $globalReceiverName) {
  264.                 if ($container->hasAlias('messenger.failure_transports.default')) {
  265.                     $failureTransportsMap[$globalReceiverName] = new Reference('messenger.failure_transports.default');
  266.                 } else {
  267.                     $failureTransportsMap[$globalReceiverName] = new Reference('messenger.transport.'.$globalReceiverName);
  268.                 }
  269.             }
  270.         }
  272.         foreach ($container->findTaggedServiceIds($this->receiverTag) as $id => $tags) {
  273.             $receiverClass = $this->getServiceClass($container, $id);
  274.             if (!is_subclass_of($receiverClass, ReceiverInterface::class)) {
  275.                 throw new RuntimeException(sprintf('Invalid receiver "%s": class "%s" must implement interface "%s".', $id, $receiverClass, ReceiverInterface::class));
  276.             }
  278.             $receiverMapping[$id] = new Reference($id);
  280.             foreach ($tags as $tag) {
  281.                 if (isset($tag['alias'])) {
  282.                     $receiverMapping[$tag['alias']] = $receiverMapping[$id];
  283.                     if ($tag['is_failure_transport'] ?? false) {
  284.                         $failureTransportsMap[$tag['alias']] = $receiverMapping[$id];
  285.                     }
  286.                 }
  287.             }
  288.         }
  290.         $receiverNames = [];
  291.         foreach ($receiverMapping as $name => $reference) {
  292.             $receiverNames[(string) $reference] = $name;
  293.         }
  295.         $buses = [];
  296.         foreach ($busIds as $busId) {
  297.             $buses[$busId] = new Reference($busId);
  298.         }
  300.         if ($hasRoutableMessageBus = $container->hasDefinition('messenger.routable_message_bus')) {
  301.             $container->getDefinition('messenger.routable_message_bus')
  302.                 ->replaceArgument(0, ServiceLocatorTagPass::register($container, $buses));
  303.         }
  305.         if ($container->hasDefinition('console.command.messenger_consume_messages')) {
  306.             $consumeCommandDefinition = $container->getDefinition('console.command.messenger_consume_messages');
  308.             if ($hasRoutableMessageBus) {
  309.                 $consumeCommandDefinition->replaceArgument(0, new Reference('messenger.routable_message_bus'));
  310.             }
  312.             $consumeCommandDefinition->replaceArgument(4, array_values($receiverNames));
  313.             try {
  314.                 $consumeCommandDefinition->replaceArgument(6, $busIds);
  315.             } catch (OutOfBoundsException $e) {
  316.                 // ignore to preserve compatibility with symfony/framework-bundle < 5.4
  317.             }
  318.         }
  320.         if ($container->hasDefinition('console.command.messenger_setup_transports')) {
  321.             $container->getDefinition('console.command.messenger_setup_transports')
  322.                 ->replaceArgument(1, array_values($receiverNames));
  323.         }
  325.         $container->getDefinition('messenger.receiver_locator')->replaceArgument(0, $receiverMapping);
  327.         $failureTransportsLocator = ServiceLocatorTagPass::register($container, $failureTransportsMap);
  329.         $failedCommandIds = [
  330.             'console.command.messenger_failed_messages_retry',
  331.             'console.command.messenger_failed_messages_show',
  332.             'console.command.messenger_failed_messages_remove',
  333.         ];
  334.         foreach ($failedCommandIds as $failedCommandId) {
  335.             if ($container->hasDefinition($failedCommandId)) {
  336.                 $definition = $container->getDefinition($failedCommandId);
  337.                 $definition->replaceArgument(1, $failureTransportsLocator);
  338.             }
  339.         }
  340.     }
  342.     private function registerBusToCollector(ContainerBuilder $container, string $busId)
  343.     {
  344.         $container->setDefinition(
  345.             $tracedBusId = 'debug.traced.'.$busId,
  346.             (new Definition(TraceableMessageBus::class, [new Reference($tracedBusId.'.inner')]))->setDecoratedService($busId)
  347.         );
  349.         $container->getDefinition('data_collector.messenger')->addMethodCall('registerBus', [$busId, new Reference($tracedBusId)]);
  350.     }
  352.     private function registerBusMiddleware(ContainerBuilder $container, string $busId, array $middlewareCollection)
  353.     {
  354.         $middlewareReferences = [];
  355.         foreach ($middlewareCollection as $middlewareItem) {
  356.             $id = $middlewareItem['id'];
  357.             $arguments = $middlewareItem['arguments'] ?? [];
  358.             if (!$container->has($messengerMiddlewareId = 'messenger.middleware.'.$id)) {
  359.                 $messengerMiddlewareId = $id;
  360.             }
  362.             if (!$container->has($messengerMiddlewareId)) {
  363.                 throw new RuntimeException(sprintf('Invalid middleware: service "%s" not found.', $id));
  364.             }
  366.             if ($container->findDefinition($messengerMiddlewareId)->isAbstract()) {
  367.                 $childDefinition = new ChildDefinition($messengerMiddlewareId);
  368.                 $childDefinition->setArguments($arguments);
  369.                 if (isset($middlewareReferences[$messengerMiddlewareId = $busId.'.middleware.'.$id])) {
  370.                     $messengerMiddlewareId .= '.'.ContainerBuilder::hash($arguments);
  371.                 }
  372.                 $container->setDefinition($messengerMiddlewareId, $childDefinition);
  373.             } elseif ($arguments) {
  374.                 throw new RuntimeException(sprintf('Invalid middleware factory "%s": a middleware factory must be an abstract definition.', $id));
  375.             }
  377.             $middlewareReferences[$messengerMiddlewareId] = new Reference($messengerMiddlewareId);
  378.         }
  380.         $container->getDefinition($busId)->replaceArgument(0, new IteratorArgument(array_values($middlewareReferences)));
  381.     }
  383.     private function getServiceClass(ContainerBuilder $container, string $serviceId): string
  384.     {
  385.         while (true) {
  386.             $definition = $container->findDefinition($serviceId);
  388.             if (!$definition->getClass() && $definition instanceof ChildDefinition) {
  389.                 $serviceId = $definition->getParent();
  391.                 continue;
  392.             }
  394.             return $definition->getClass();
  395.         }
  396.     }
  397. }