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

  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.     public function process(ContainerBuilder $container)
  37.     {
  38.         $busIds = [];
  39.         foreach ($container->findTaggedServiceIds('messenger.bus') as $busId => $tags) {
  40.             $busIds[] = $busId;
  41.             if ($container->hasParameter($busMiddlewareParameter = $busId.'.middleware')) {
  42.                 $this->registerBusMiddleware($container, $busId, $container->getParameter($busMiddlewareParameter));
  44.                 $container->getParameterBag()->remove($busMiddlewareParameter);
  45.             }
  47.             if ($container->hasDefinition('data_collector.messenger')) {
  48.                 $this->registerBusToCollector($container, $busId);
  49.             }
  50.         }
  52.         if ($container->hasDefinition('messenger.receiver_locator')) {
  53.             $this->registerReceivers($container, $busIds);
  54.         }
  55.         $this->registerHandlers($container, $busIds);
  56.     }
  58.     private function registerHandlers(ContainerBuilder $container, array $busIds)
  59.     {
  60.         $definitions = [];
  61.         $handlersByBusAndMessage = [];
  62.         $handlerToOriginalServiceIdMapping = [];
  64.         foreach ($container->findTaggedServiceIds('messenger.message_handler', true) as $serviceId => $tags) {
  65.             foreach ($tags as $tag) {
  66.                 if (isset($tag['bus']) && !\in_array($tag['bus'], $busIds, true)) {
  67.                     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)));
  68.                 }
  70.                 $className = $this->getServiceClass($container, $serviceId);
  71.                 $r = $container->getReflectionClass($className);
  73.                 if (null === $r) {
  74.                     throw new RuntimeException(sprintf('Invalid service "%s": class "%s" does not exist.', $serviceId, $className));
  75.                 }
  77.                 if (isset($tag['handles'])) {
  78.                     $handles = isset($tag['method']) ? [$tag['handles'] => $tag['method']] : [$tag['handles']];
  79.                 } else {
  80.                     $handles = $this->guessHandledClasses($r, $serviceId, $tag['method'] ?? '__invoke');
  81.                 }
  83.                 $message = null;
  84.                 $handlerBuses = (array) ($tag['bus'] ?? $busIds);
  86.                 foreach ($handles as $message => $options) {
  87.                     $buses = $handlerBuses;
  89.                     if (\is_int($message)) {
  90.                         if (\is_string($options)) {
  91.                             $message = $options;
  92.                             $options = [];
  93.                         } else {
  94.                             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));
  95.                         }
  96.                     }
  98.                     if (\is_string($options)) {
  99.                         $options = ['method' => $options];
  100.                     }
  102.                     $options += array_filter($tag);
  103.                     unset($options['handles']);
  104.                     $priority = $options['priority'] ?? 0;
  105.                     $method = $options['method'] ?? '__invoke';
  107.                     if (isset($options['bus'])) {
  108.                         if (!\in_array($options['bus'], $busIds)) {
  109.                             // @deprecated since Symfony 6.2, in 7.0 change to:
  110.                             // $messageLocation = isset($tag['handles']) ? 'declared in your tag attribute "handles"' : sprintf('used as argument type in method "%s::%s()"', $r->getName(), $method);
  111.                             $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));
  113.                             throw new RuntimeException(sprintf('Invalid configuration '.$messageLocation.' for message "%s": bus "%s" does not exist.', $message, $options['bus']));
  114.                         }
  116.                         $buses = [$options['bus']];
  117.                     }
  119.                     if ('*' !== $message && !class_exists($message) && !interface_exists($message, false)) {
  120.                         // @deprecated since Symfony 6.2, in 7.0 change to:
  121.                         // $messageLocation = isset($tag['handles']) ? 'declared in your tag attribute "handles"' : sprintf('used as argument type in method "%s::%s()"', $r->getName(), $method);
  122.                         $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));
  124.                         throw new RuntimeException(sprintf('Invalid handler service "%s": class or interface "%s" '.$messageLocation.' not found.', $serviceId, $message));
  125.                     }
  127.                     if (!$r->hasMethod($method)) {
  128.                         throw new RuntimeException(sprintf('Invalid handler service "%s": method "%s::%s()" does not exist.', $serviceId, $r->getName(), $method));
  129.                     }
  131.                     if ('__invoke' !== $method) {
  132.                         $wrapperDefinition = (new Definition('Closure'))->addArgument([new Reference($serviceId), $method])->setFactory('Closure::fromCallable');
  134.                         $definitions[$definitionId = '.messenger.method_on_object_wrapper.'.ContainerBuilder::hash($message.':'.$priority.':'.$serviceId.':'.$method)] = $wrapperDefinition;
  135.                     } else {
  136.                         $definitionId = $serviceId;
  137.                     }
  139.                     $handlerToOriginalServiceIdMapping[$definitionId] = $serviceId;
  141.                     foreach ($buses as $handlerBus) {
  142.                         $handlersByBusAndMessage[$handlerBus][$message][$priority][] = [$definitionId, $options];
  143.                     }
  144.                 }
  146.                 if (null === $message) {
  147.                     throw new RuntimeException(sprintf('Invalid handler service "%s": method "%s::getHandledMessages()" must return one or more messages.', $serviceId, $r->getName()));
  148.                 }
  149.             }
  150.         }
  152.         foreach ($handlersByBusAndMessage as $bus => $handlersByMessage) {
  153.             foreach ($handlersByMessage as $message => $handlersByPriority) {
  154.                 krsort($handlersByPriority);
  155.                 $handlersByBusAndMessage[$bus][$message] = array_merge(...$handlersByPriority);
  156.             }
  157.         }
  159.         $handlersLocatorMappingByBus = [];
  160.         foreach ($handlersByBusAndMessage as $bus => $handlersByMessage) {
  161.             foreach ($handlersByMessage as $message => $handlers) {
  162.                 $handlerDescriptors = [];
  163.                 foreach ($handlers as $handler) {
  164.                     $definitions[$definitionId = '.messenger.handler_descriptor.'.ContainerBuilder::hash($bus.':'.$message.':'.$handler[0])] = (new Definition(HandlerDescriptor::class))->setArguments([new Reference($handler[0]), $handler[1]]);
  165.                     $handlerDescriptors[] = new Reference($definitionId);
  166.                 }
  168.                 $handlersLocatorMappingByBus[$bus][$message] = new IteratorArgument($handlerDescriptors);
  169.             }
  170.         }
  171.         $container->addDefinitions($definitions);
  173.         foreach ($busIds as $bus) {
  174.             $container->register($locatorId = $bus.'.messenger.handlers_locator', HandlersLocator::class)
  175.                 ->setArgument(0, $handlersLocatorMappingByBus[$bus] ?? [])
  176.             ;
  177.             if ($container->has($handleMessageId = $bus.'.middleware.handle_message')) {
  178.                 $container->getDefinition($handleMessageId)
  179.                     ->replaceArgument(0, new Reference($locatorId))
  180.                 ;
  181.             }
  182.         }
  184.         if ($container->hasDefinition('console.command.messenger_debug')) {
  185.             $debugCommandMapping = $handlersByBusAndMessage;
  186.             foreach ($busIds as $bus) {
  187.                 if (!isset($debugCommandMapping[$bus])) {
  188.                     $debugCommandMapping[$bus] = [];
  189.                 }
  191.                 foreach ($debugCommandMapping[$bus] as $message => $handlers) {
  192.                     foreach ($handlers as $key => $handler) {
  193.                         $debugCommandMapping[$bus][$message][$key][0] = $handlerToOriginalServiceIdMapping[$handler[0]];
  194.                     }
  195.                 }
  196.             }
  197.             $container->getDefinition('console.command.messenger_debug')->replaceArgument(0, $debugCommandMapping);
  198.         }
  199.     }
  201.     private function guessHandledClasses(\ReflectionClass $handlerClass, string $serviceId, string $methodName): iterable
  202.     {
  203.         if ($handlerClass->implementsInterface(MessageSubscriberInterface::class)) {
  204.             trigger_deprecation('symfony/messenger', '6.2', 'Implementing "%s" is deprecated, use the "%s" attribute instead.', MessageSubscriberInterface::class, AsMessageHandler::class);
  206.             return $handlerClass->getName()::getHandledMessages();
  207.         }
  209.         if ($handlerClass->implementsInterface(MessageHandlerInterface::class)) {
  210.             trigger_deprecation('symfony/messenger', '6.2', 'Implementing "%s" is deprecated, use the "%s" attribute instead.', MessageHandlerInterface::class, AsMessageHandler::class);
  211.         }
  213.         try {
  214.             $method = $handlerClass->getMethod($methodName);
  215.         } catch (\ReflectionException) {
  216.             throw new RuntimeException(sprintf('Invalid handler service "%s": class "%s" must have an "%s()" method.', $serviceId, $handlerClass->getName(), $methodName));
  217.         }
  219.         if (0 === $method->getNumberOfRequiredParameters()) {
  220.             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));
  221.         }
  223.         $parameters = $method->getParameters();
  225.         /** @var \ReflectionNamedType|\ReflectionUnionType|null */
  226.         $type = $parameters[0]->getType();
  228.         if (!$type) {
  229.             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));
  230.         }
  232.         if ($type instanceof \ReflectionUnionType) {
  233.             $types = [];
  234.             $invalidTypes = [];
  235.             foreach ($type->getTypes() as $type) {
  236.                 if (!$type->isBuiltin()) {
  237.                     $types[] = (string) $type;
  238.                 } else {
  239.                     $invalidTypes[] = (string) $type;
  240.                 }
  241.             }
  243.             if ($types) {
  244.                 return ('__invoke' === $methodName) ? $types : array_fill_keys($types, $methodName);
  245.             }
  247.             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)));
  248.         }
  250.         if ($type->isBuiltin()) {
  251.             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));
  252.         }
  254.         return ('__invoke' === $methodName) ? [$type->getName()] : [$type->getName() => $methodName];
  255.     }
  257.     private function registerReceivers(ContainerBuilder $container, array $busIds)
  258.     {
  259.         $receiverMapping = [];
  260.         $failureTransportsMap = [];
  261.         if ($container->hasDefinition('console.command.messenger_failed_messages_retry')) {
  262.             $commandDefinition = $container->getDefinition('console.command.messenger_failed_messages_retry');
  263.             $globalReceiverName = $commandDefinition->getArgument(0);
  264.             if (null !== $globalReceiverName) {
  265.                 if ($container->hasAlias('messenger.failure_transports.default')) {
  266.                     $failureTransportsMap[$globalReceiverName] = new Reference('messenger.failure_transports.default');
  267.                 } else {
  268.                     $failureTransportsMap[$globalReceiverName] = new Reference('messenger.transport.'.$globalReceiverName);
  269.                 }
  270.             }
  271.         }
  273.         foreach ($container->findTaggedServiceIds('messenger.receiver') as $id => $tags) {
  274.             $receiverClass = $this->getServiceClass($container, $id);
  275.             if (!is_subclass_of($receiverClass, ReceiverInterface::class)) {
  276.                 throw new RuntimeException(sprintf('Invalid receiver "%s": class "%s" must implement interface "%s".', $id, $receiverClass, ReceiverInterface::class));
  277.             }
  279.             $receiverMapping[$id] = new Reference($id);
  281.             foreach ($tags as $tag) {
  282.                 if (isset($tag['alias'])) {
  283.                     $receiverMapping[$tag['alias']] = $receiverMapping[$id];
  284.                     if ($tag['is_failure_transport'] ?? false) {
  285.                         $failureTransportsMap[$tag['alias']] = $receiverMapping[$id];
  286.                     }
  287.                 }
  288.             }
  289.         }
  291.         $receiverNames = [];
  292.         foreach ($receiverMapping as $name => $reference) {
  293.             $receiverNames[(string) $reference] = $name;
  294.         }
  296.         $buses = [];
  297.         foreach ($busIds as $busId) {
  298.             $buses[$busId] = new Reference($busId);
  299.         }
  301.         if ($hasRoutableMessageBus = $container->hasDefinition('messenger.routable_message_bus')) {
  302.             $container->getDefinition('messenger.routable_message_bus')
  303.                 ->replaceArgument(0, ServiceLocatorTagPass::register($container, $buses));
  304.         }
  306.         if ($container->hasDefinition('console.command.messenger_consume_messages')) {
  307.             $consumeCommandDefinition = $container->getDefinition('console.command.messenger_consume_messages');
  309.             if ($hasRoutableMessageBus) {
  310.                 $consumeCommandDefinition->replaceArgument(0, new Reference('messenger.routable_message_bus'));
  311.             }
  313.             $consumeCommandDefinition->replaceArgument(4, array_values($receiverNames));
  314.             try {
  315.                 $consumeCommandDefinition->replaceArgument(6, $busIds);
  316.             } catch (OutOfBoundsException) {
  317.                 // ignore to preserve compatibility with symfony/framework-bundle < 5.4
  318.             }
  319.         }
  321.         if ($container->hasDefinition('console.command.messenger_setup_transports')) {
  322.             $container->getDefinition('console.command.messenger_setup_transports')
  323.                 ->replaceArgument(1, array_values($receiverNames));
  324.         }
  326.         if ($container->hasDefinition('console.command.messenger_stats')) {
  327.             $container->getDefinition('console.command.messenger_stats')
  328.                 ->replaceArgument(1, array_values($receiverNames));
  329.         }
  331.         $container->getDefinition('messenger.receiver_locator')->replaceArgument(0, $receiverMapping);
  333.         $failureTransportsLocator = ServiceLocatorTagPass::register($container, $failureTransportsMap);
  335.         $failedCommandIds = [
  336.             'console.command.messenger_failed_messages_retry',
  337.             'console.command.messenger_failed_messages_show',
  338.             'console.command.messenger_failed_messages_remove',
  339.         ];
  340.         foreach ($failedCommandIds as $failedCommandId) {
  341.             if ($container->hasDefinition($failedCommandId)) {
  342.                 $definition = $container->getDefinition($failedCommandId);
  343.                 $definition->replaceArgument(1, $failureTransportsLocator);
  344.             }
  345.         }
  346.     }
  348.     private function registerBusToCollector(ContainerBuilder $container, string $busId)
  349.     {
  350.         $container->setDefinition(
  351.             $tracedBusId = 'debug.traced.'.$busId,
  352.             (new Definition(TraceableMessageBus::class, [new Reference($tracedBusId.'.inner')]))->setDecoratedService($busId)
  353.         );
  355.         $container->getDefinition('data_collector.messenger')->addMethodCall('registerBus', [$busId, new Reference($tracedBusId)]);
  356.     }
  358.     private function registerBusMiddleware(ContainerBuilder $container, string $busId, array $middlewareCollection)
  359.     {
  360.         $middlewareReferences = [];
  361.         foreach ($middlewareCollection as $middlewareItem) {
  362.             $id = $middlewareItem['id'];
  363.             $arguments = $middlewareItem['arguments'] ?? [];
  364.             if (!$container->has($messengerMiddlewareId = 'messenger.middleware.'.$id)) {
  365.                 $messengerMiddlewareId = $id;
  366.             }
  368.             if (!$container->has($messengerMiddlewareId)) {
  369.                 throw new RuntimeException(sprintf('Invalid middleware: service "%s" not found.', $id));
  370.             }
  372.             if ($container->findDefinition($messengerMiddlewareId)->isAbstract()) {
  373.                 $childDefinition = new ChildDefinition($messengerMiddlewareId);
  374.                 $childDefinition->setArguments($arguments);
  375.                 if (isset($middlewareReferences[$messengerMiddlewareId = $busId.'.middleware.'.$id])) {
  376.                     $messengerMiddlewareId .= '.'.ContainerBuilder::hash($arguments);
  377.                 }
  378.                 $container->setDefinition($messengerMiddlewareId, $childDefinition);
  379.             } elseif ($arguments) {
  380.                 throw new RuntimeException(sprintf('Invalid middleware factory "%s": a middleware factory must be an abstract definition.', $id));
  381.             }
  383.             $middlewareReferences[$messengerMiddlewareId] = new Reference($messengerMiddlewareId);
  384.         }
  386.         $container->getDefinition($busId)->replaceArgument(0, new IteratorArgument(array_values($middlewareReferences)));
  387.     }
  389.     private function getServiceClass(ContainerBuilder $container, string $serviceId): string
  390.     {
  391.         while (true) {
  392.             $definition = $container->findDefinition($serviceId);
  394.             if (!$definition->getClass() && $definition instanceof ChildDefinition) {
  395.                 $serviceId = $definition->getParent();
  397.                 continue;
  398.             }
  400.             return $definition->getClass();
  401.         }
  402.     }
  403. }