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

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\Attribute\AsMessageHandler;
  24. use Symfony\Component\Messenger\Handler\HandlerDescriptor;
  25. use Symfony\Component\Messenger\Handler\HandlersLocator;
  26. use Symfony\Component\Messenger\Handler\MessageHandlerInterface;
  27. use Symfony\Component\Messenger\Handler\MessageSubscriberInterface;
  28. use Symfony\Component\Messenger\TraceableMessageBus;
  29. use Symfony\Component\Messenger\Transport\Receiver\ReceiverInterface;
  31. /**
  32.  * @author Samuel Roze <samuel.roze@gmail.com>
  33.  */
  34. class MessengerPass implements CompilerPassInterface
  35. {
  36.     /**
  37.      * @return void
  38.      */
  39.     public function process(ContainerBuilder $container)
  40.     {
  41.         $busIds = [];
  42.         foreach ($container->findTaggedServiceIds('messenger.bus') as $busId => $tags) {
  43.             $busIds[] = $busId;
  44.             if ($container->hasParameter($busMiddlewareParameter = $busId.'.middleware')) {
  45.                 $this->registerBusMiddleware($container, $busId, $container->getParameter($busMiddlewareParameter));
  47.                 $container->getParameterBag()->remove($busMiddlewareParameter);
  48.             }
  50.             if ($container->hasDefinition('data_collector.messenger')) {
  51.                 $this->registerBusToCollector($container, $busId);
  52.             }
  53.         }
  55.         if ($container->hasDefinition('messenger.receiver_locator')) {
  56.             $this->registerReceivers($container, $busIds);
  57.         }
  58.         $this->registerHandlers($container, $busIds);
  59.     }
  61.     private function registerHandlers(ContainerBuilder $container, array $busIds): void
  62.     {
  63.         $definitions = [];
  64.         $handlersByBusAndMessage = [];
  65.         $handlerToOriginalServiceIdMapping = [];
  67.         foreach ($container->findTaggedServiceIds('messenger.message_handler', true) as $serviceId => $tags) {
  68.             foreach ($tags as $tag) {
  69.                 if (isset($tag['bus']) && !\in_array($tag['bus'], $busIds, true)) {
  70.                     throw new RuntimeException(sprintf('Invalid handler service "%s": bus "%s" specified on the tag "messenger.message_handler" does not exist (known ones are: "%s").', $serviceId, $tag['bus'], implode('", "', $busIds)));
  71.                 }
  73.                 $className = $this->getServiceClass($container, $serviceId);
  74.                 $r = $container->getReflectionClass($className);
  76.                 if (null === $r) {
  77.                     throw new RuntimeException(sprintf('Invalid service "%s": class "%s" does not exist.', $serviceId, $className));
  78.                 }
  80.                 if (isset($tag['handles'])) {
  81.                     $handles = isset($tag['method']) ? [$tag['handles'] => $tag['method']] : [$tag['handles']];
  82.                 } else {
  83.                     $handles = $this->guessHandledClasses($r, $serviceId, $tag['method'] ?? '__invoke');
  84.                 }
  86.                 $message = null;
  87.                 $handlerBuses = (array) ($tag['bus'] ?? $busIds);
  89.                 foreach ($handles as $message => $options) {
  90.                     $buses = $handlerBuses;
  92.                     if (\is_int($message)) {
  93.                         if (\is_string($options)) {
  94.                             $message = $options;
  95.                             $options = [];
  96.                         } else {
  97.                             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));
  98.                         }
  99.                     }
  101.                     if (\is_string($options)) {
  102.                         $options = ['method' => $options];
  103.                     }
  105.                     $options += array_filter($tag);
  106.                     unset($options['handles']);
  107.                     $priority = $options['priority'] ?? 0;
  108.                     $method = $options['method'] ?? '__invoke';
  110.                     if (isset($options['bus'])) {
  111.                         if (!\in_array($options['bus'], $busIds)) {
  112.                             // @deprecated since Symfony 6.2, in 7.0 change to:
  113.                             // $messageLocation = isset($tag['handles']) ? 'declared in your tag attribute "handles"' : sprintf('used as argument type in method "%s::%s()"', $r->getName(), $method);
  114.                             $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));
  116.                             throw new RuntimeException(sprintf('Invalid configuration '.$messageLocation.' for message "%s": bus "%s" does not exist.', $message, $options['bus']));
  117.                         }
  119.                         $buses = [$options['bus']];
  120.                     }
  122.                     if ('*' !== $message && !class_exists($message) && !interface_exists($message, false)) {
  123.                         // @deprecated since Symfony 6.2, in 7.0 change to:
  124.                         // $messageLocation = isset($tag['handles']) ? 'declared in your tag attribute "handles"' : sprintf('used as argument type in method "%s::%s()"', $r->getName(), $method);
  125.                         $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));
  127.                         throw new RuntimeException(sprintf('Invalid handler service "%s": class or interface "%s" '.$messageLocation.' not found.', $serviceId, $message));
  128.                     }
  130.                     if (!$r->hasMethod($method)) {
  131.                         throw new RuntimeException(sprintf('Invalid handler service "%s": method "%s::%s()" does not exist.', $serviceId, $r->getName(), $method));
  132.                     }
  134.                     if ('__invoke' !== $method) {
  135.                         $wrapperDefinition = (new Definition('Closure'))->addArgument([new Reference($serviceId), $method])->setFactory('Closure::fromCallable');
  137.                         $definitions[$definitionId = '.messenger.method_on_object_wrapper.'.ContainerBuilder::hash($message.':'.$priority.':'.$serviceId.':'.$method)] = $wrapperDefinition;
  138.                     } else {
  139.                         $definitionId = $serviceId;
  140.                     }
  142.                     $handlerToOriginalServiceIdMapping[$definitionId] = $serviceId;
  144.                     foreach ($buses as $handlerBus) {
  145.                         $handlersByBusAndMessage[$handlerBus][$message][$priority][] = [$definitionId, $options];
  146.                     }
  147.                 }
  149.                 if (null === $message) {
  150.                     throw new RuntimeException(sprintf('Invalid handler service "%s": method "%s::getHandledMessages()" must return one or more messages.', $serviceId, $r->getName()));
  151.                 }
  152.             }
  153.         }
  155.         foreach ($handlersByBusAndMessage as $bus => $handlersByMessage) {
  156.             foreach ($handlersByMessage as $message => $handlersByPriority) {
  157.                 krsort($handlersByPriority);
  158.                 $handlersByBusAndMessage[$bus][$message] = array_merge(...$handlersByPriority);
  159.             }
  160.         }
  162.         $handlersLocatorMappingByBus = [];
  163.         foreach ($handlersByBusAndMessage as $bus => $handlersByMessage) {
  164.             foreach ($handlersByMessage as $message => $handlers) {
  165.                 $handlerDescriptors = [];
  166.                 foreach ($handlers as $handler) {
  167.                     $definitions[$definitionId = '.messenger.handler_descriptor.'.ContainerBuilder::hash($bus.':'.$message.':'.$handler[0])] = (new Definition(HandlerDescriptor::class))->setArguments([new Reference($handler[0]), $handler[1]]);
  168.                     $handlerDescriptors[] = new Reference($definitionId);
  169.                 }
  171.                 $handlersLocatorMappingByBus[$bus][$message] = new IteratorArgument($handlerDescriptors);
  172.             }
  173.         }
  174.         $container->addDefinitions($definitions);
  176.         foreach ($busIds as $bus) {
  177.             $container->register($locatorId = $bus.'.messenger.handlers_locator', HandlersLocator::class)
  178.                 ->setArgument(0, $handlersLocatorMappingByBus[$bus] ?? [])
  179.             ;
  180.             if ($container->has($handleMessageId = $bus.'.middleware.handle_message')) {
  181.                 $container->getDefinition($handleMessageId)
  182.                     ->replaceArgument(0, new Reference($locatorId))
  183.                 ;
  184.             }
  185.         }
  187.         if ($container->hasDefinition('console.command.messenger_debug')) {
  188.             $debugCommandMapping = $handlersByBusAndMessage;
  189.             foreach ($busIds as $bus) {
  190.                 if (!isset($debugCommandMapping[$bus])) {
  191.                     $debugCommandMapping[$bus] = [];
  192.                 }
  194.                 foreach ($debugCommandMapping[$bus] as $message => $handlers) {
  195.                     foreach ($handlers as $key => $handler) {
  196.                         $debugCommandMapping[$bus][$message][$key][0] = $handlerToOriginalServiceIdMapping[$handler[0]];
  197.                     }
  198.                 }
  199.             }
  200.             $container->getDefinition('console.command.messenger_debug')->replaceArgument(0, $debugCommandMapping);
  201.         }
  202.     }
  204.     private function guessHandledClasses(\ReflectionClass $handlerClass, string $serviceId, string $methodName): iterable
  205.     {
  206.         if ($handlerClass->implementsInterface(MessageSubscriberInterface::class)) {
  207.             trigger_deprecation('symfony/messenger', '6.2', 'Implementing "%s" is deprecated, use the "%s" attribute instead.', MessageSubscriberInterface::class, AsMessageHandler::class);
  209.             return $handlerClass->getName()::getHandledMessages();
  210.         }
  212.         if ($handlerClass->implementsInterface(MessageHandlerInterface::class)) {
  213.             trigger_deprecation('symfony/messenger', '6.2', 'Implementing "%s" is deprecated, use the "%s" attribute instead.', MessageHandlerInterface::class, AsMessageHandler::class);
  214.         }
  216.         try {
  217.             $method = $handlerClass->getMethod($methodName);
  218.         } catch (\ReflectionException) {
  219.             throw new RuntimeException(sprintf('Invalid handler service "%s": class "%s" must have an "%s()" method.', $serviceId, $handlerClass->getName(), $methodName));
  220.         }
  222.         if (0 === $method->getNumberOfRequiredParameters()) {
  223.             throw new RuntimeException(sprintf('Invalid handler service "%s": method "%s::%s()" requires at least one argument, first one being the message it handles.', $serviceId, $handlerClass->getName(), $methodName));
  224.         }
  226.         $parameters = $method->getParameters();
  228.         /** @var \ReflectionNamedType|\ReflectionUnionType|null */
  229.         $type = $parameters[0]->getType();
  231.         if (!$type) {
  232.             throw new RuntimeException(sprintf('Invalid handler service "%s": argument "$%s" of method "%s::%s()" must have a type-hint corresponding to the message class it handles.', $serviceId, $parameters[0]->getName(), $handlerClass->getName(), $methodName));
  233.         }
  235.         if ($type instanceof \ReflectionUnionType) {
  236.             $types = [];
  237.             $invalidTypes = [];
  238.             foreach ($type->getTypes() as $type) {
  239.                 if (!$type->isBuiltin()) {
  240.                     $types[] = (string) $type;
  241.                 } else {
  242.                     $invalidTypes[] = (string) $type;
  243.                 }
  244.             }
  246.             if ($types) {
  247.                 return ('__invoke' === $methodName) ? $types : array_fill_keys($types, $methodName);
  248.             }
  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(), implode('|', $invalidTypes)));
  251.         }
  253.         if ($type->isBuiltin()) {
  254.             throw new RuntimeException(sprintf('Invalid handler service "%s": type-hint of argument "$%s" in method "%s::%s()" must be a class , "%s" given.', $serviceId, $parameters[0]->getName(), $handlerClass->getName(), $methodName, $type instanceof \ReflectionNamedType ? $type->getName() : (string) $type));
  255.         }
  257.         return ('__invoke' === $methodName) ? [$type->getName()] : [$type->getName() => $methodName];
  258.     }
  260.     private function registerReceivers(ContainerBuilder $container, array $busIds): void
  261.     {
  262.         $receiverMapping = [];
  263.         $failureTransportsMap = [];
  264.         if ($container->hasDefinition('console.command.messenger_failed_messages_retry')) {
  265.             $commandDefinition = $container->getDefinition('console.command.messenger_failed_messages_retry');
  266.             $globalReceiverName = $commandDefinition->getArgument(0);
  267.             if (null !== $globalReceiverName) {
  268.                 if ($container->hasAlias('messenger.failure_transports.default')) {
  269.                     $failureTransportsMap[$globalReceiverName] = new Reference('messenger.failure_transports.default');
  270.                 } else {
  271.                     $failureTransportsMap[$globalReceiverName] = new Reference('messenger.transport.'.$globalReceiverName);
  272.                 }
  273.             }
  274.         }
  276.         foreach ($container->findTaggedServiceIds('messenger.receiver') as $id => $tags) {
  277.             $receiverClass = $this->getServiceClass($container, $id);
  278.             if (!is_subclass_of($receiverClass, ReceiverInterface::class)) {
  279.                 throw new RuntimeException(sprintf('Invalid receiver "%s": class "%s" must implement interface "%s".', $id, $receiverClass, ReceiverInterface::class));
  280.             }
  282.             $receiverMapping[$id] = new Reference($id);
  284.             foreach ($tags as $tag) {
  285.                 if (isset($tag['alias'])) {
  286.                     $receiverMapping[$tag['alias']] = $receiverMapping[$id];
  287.                     if ($tag['is_failure_transport'] ?? false) {
  288.                         $failureTransportsMap[$tag['alias']] = $receiverMapping[$id];
  289.                     }
  290.                 }
  291.             }
  292.         }
  294.         $receiverNames = [];
  295.         foreach ($receiverMapping as $name => $reference) {
  296.             $receiverNames[(string) $reference] = $name;
  297.         }
  299.         $buses = [];
  300.         foreach ($busIds as $busId) {
  301.             $buses[$busId] = new Reference($busId);
  302.         }
  304.         if ($hasRoutableMessageBus = $container->hasDefinition('messenger.routable_message_bus')) {
  305.             $container->getDefinition('messenger.routable_message_bus')
  306.                 ->replaceArgument(0, ServiceLocatorTagPass::register($container, $buses));
  307.         }
  309.         if ($container->hasDefinition('console.command.messenger_consume_messages')) {
  310.             $consumeCommandDefinition = $container->getDefinition('console.command.messenger_consume_messages');
  312.             if ($hasRoutableMessageBus) {
  313.                 $consumeCommandDefinition->replaceArgument(0, new Reference('messenger.routable_message_bus'));
  314.             }
  316.             $consumeCommandDefinition->replaceArgument(4, array_values($receiverNames));
  317.             try {
  318.                 $consumeCommandDefinition->replaceArgument(6, $busIds);
  319.             } catch (OutOfBoundsException) {
  320.                 // ignore to preserve compatibility with symfony/framework-bundle < 5.4
  321.             }
  322.         }
  324.         if ($container->hasDefinition('console.command.messenger_setup_transports')) {
  325.             $container->getDefinition('console.command.messenger_setup_transports')
  326.                 ->replaceArgument(1, array_values($receiverNames));
  327.         }
  329.         if ($container->hasDefinition('console.command.messenger_stats')) {
  330.             $container->getDefinition('console.command.messenger_stats')
  331.                 ->replaceArgument(1, array_values($receiverNames));
  332.         }
  334.         $container->getDefinition('messenger.receiver_locator')->replaceArgument(0, $receiverMapping);
  336.         $failureTransportsLocator = ServiceLocatorTagPass::register($container, $failureTransportsMap);
  338.         $failedCommandIds = [
  339.             'console.command.messenger_failed_messages_retry',
  340.             'console.command.messenger_failed_messages_show',
  341.             'console.command.messenger_failed_messages_remove',
  342.         ];
  343.         foreach ($failedCommandIds as $failedCommandId) {
  344.             if ($container->hasDefinition($failedCommandId)) {
  345.                 $definition = $container->getDefinition($failedCommandId);
  346.                 $definition->replaceArgument(1, $failureTransportsLocator);
  347.             }
  348.         }
  349.     }
  351.     private function registerBusToCollector(ContainerBuilder $container, string $busId): void
  352.     {
  353.         $container->setDefinition(
  354.             $tracedBusId = 'debug.traced.'.$busId,
  355.             (new Definition(TraceableMessageBus::class, [new Reference($tracedBusId.'.inner')]))->setDecoratedService($busId)
  356.         );
  358.         $container->getDefinition('data_collector.messenger')->addMethodCall('registerBus', [$busId, new Reference($tracedBusId)]);
  359.     }
  361.     private function registerBusMiddleware(ContainerBuilder $container, string $busId, array $middlewareCollection): void
  362.     {
  363.         $middlewareReferences = [];
  364.         foreach ($middlewareCollection as $middlewareItem) {
  365.             $id = $middlewareItem['id'];
  366.             $arguments = $middlewareItem['arguments'] ?? [];
  367.             if (!$container->has($messengerMiddlewareId = 'messenger.middleware.'.$id)) {
  368.                 $messengerMiddlewareId = $id;
  369.             }
  371.             if (!$container->has($messengerMiddlewareId)) {
  372.                 throw new RuntimeException(sprintf('Invalid middleware: service "%s" not found.', $id));
  373.             }
  375.             if ($container->findDefinition($messengerMiddlewareId)->isAbstract()) {
  376.                 $childDefinition = new ChildDefinition($messengerMiddlewareId);
  377.                 $childDefinition->setArguments($arguments);
  378.                 if (isset($middlewareReferences[$messengerMiddlewareId = $busId.'.middleware.'.$id])) {
  379.                     $messengerMiddlewareId .= '.'.ContainerBuilder::hash($arguments);
  380.                 }
  381.                 $container->setDefinition($messengerMiddlewareId, $childDefinition);
  382.             } elseif ($arguments) {
  383.                 throw new RuntimeException(sprintf('Invalid middleware factory "%s": a middleware factory must be an abstract definition.', $id));
  384.             }
  386.             $middlewareReferences[$messengerMiddlewareId] = new Reference($messengerMiddlewareId);
  387.         }
  389.         $container->getDefinition($busId)->replaceArgument(0, new IteratorArgument(array_values($middlewareReferences)));
  390.     }
  392.     private function getServiceClass(ContainerBuilder $container, string $serviceId): string
  393.     {
  394.         while (true) {
  395.             $definition = $container->findDefinition($serviceId);
  397.             if (!$definition->getClass() && $definition instanceof ChildDefinition) {
  398.                 $serviceId = $definition->getParent();
  400.                 continue;
  401.             }
  403.             return $definition->getClass();
  404.         }
  405.     }
  406. }