Merge remote-tracking branch 'origin/4.3'

* origin/4.3:
  deprecate calling createChildContext without the format parameter
  [EventDispatcher] Fix interface name used in error messages
  [FrameworkBundle] Add cache configuration for PropertyInfo
  Update dependencies in the main component
  Drop useless executable bit
  [Doctrine][PropertyInfo] Detect if the ID is writeable
  Add transport in subscriber's phpdoc
  [Validator] Autovalidation: skip readonly props
  [DI] default to service id - *not* FQCN - when building tagged locators
  [Cache] Log a more readable error message when saving into cache fails
  Update WorkflowEvents.php
  [Messenger] On failure retry, make message appear received from original sender
  [Messenger] remove send_and_handle option which can be achieved with SyncTransport
  Fixing tests - passing pdo is not wrapped for some reason in dbal
  Changing how RoutableMessageBus fallback bus works
  [Serializer] Fix BC break: DEPTH_KEY_PATTERN must be public
  [FrameworkBundle] Fixed issue when a parameter container a '%'
  Fix the interface incompatibility of EventDispatchers
  [TwigBundle] fixed Mailer integration in Twig
  [Form] Add intl/choice_translation_locale option to TimezoneType

Author: lyrixx

CHANGELOG.md

@@ -6,6 +6,7 @@ CHANGELOG
 
  * [BC BREAK] `SendersLocatorInterface` has an additional method:
    `getSenderByAlias()`.
+ * Removed argument `?bool &$handle = false` from `SendersLocatorInterface::getSenders`
  * A new `ListableReceiverInterface` was added, which a receiver
    can implement (when applicable) to enable listing and fetching
    individual messages by id (used in the new "Failed Messages" commands).

Command/AbstractFailedMessagesCommand.php

@@ -15,6 +15,7 @@
 use Symfony\Component\Console\Helper\Dumper;
 use Symfony\Component\Console\Style\SymfonyStyle;
 use Symfony\Component\Messenger\Envelope;
+use Symfony\Component\Messenger\Stamp\RedeliveryStamp;
 use Symfony\Component\Messenger\Stamp\SentToFailureTransportStamp;
 use Symfony\Component\Messenger\Stamp\TransportMessageIdStamp;
 use Symfony\Component\Messenger\Transport\Receiver\MessageCountAwareInterface;
@@ -59,8 +60,10 @@ protected function displaySingleMessage(Envelope $envelope, SymfonyStyle $io)
     {
         $io->title('Failed Message Details');
 
-        /** @var SentToFailureTransportStamp $sentToFailureTransportStamp */
+        /** @var SentToFailureTransportStamp|null $sentToFailureTransportStamp */
         $sentToFailureTransportStamp = $envelope->last(SentToFailureTransportStamp::class);
+        /** @var RedeliveryStamp|null $lastRedeliveryStamp */
+        $lastRedeliveryStamp = $envelope->last(RedeliveryStamp::class);
 
         $rows = [
             ['Class', \get_class($envelope->getMessage())],
@@ -70,25 +73,34 @@ protected function displaySingleMessage(Envelope $envelope, SymfonyStyle $io)
             $rows[] = ['Message Id', $id];
         }
 
+        $flattenException = null === $lastRedeliveryStamp ? null : $lastRedeliveryStamp->getFlattenException();
         if (null === $sentToFailureTransportStamp) {
             $io->warning('Message does not appear to have been sent to this transport after failing');
         } else {
             $rows = array_merge($rows, [
-                ['Failed at', $sentToFailureTransportStamp->getSentAt()->format('Y-m-d H:i:s')],
-                ['Error', $sentToFailureTransportStamp->getExceptionMessage()],
-                ['Error Class', $sentToFailureTransportStamp->getFlattenException() ? $sentToFailureTransportStamp->getFlattenException()->getClass() : '(unknown)'],
+                ['Failed at', null === $lastRedeliveryStamp ? '' : $lastRedeliveryStamp->getRedeliveredAt()->format('Y-m-d H:i:s')],
+                ['Error', null === $lastRedeliveryStamp ? '' : $lastRedeliveryStamp->getExceptionMessage()],
+                ['Error Class', null === $flattenException ? '(unknown)' : $flattenException->getClass()],
                 ['Transport', $sentToFailureTransportStamp->getOriginalReceiverName()],
             ]);
         }
 
         $io->table([], $rows);
 
+        /** @var RedeliveryStamp[] $redeliveryStamps */
+        $redeliveryStamps = $envelope->all(RedeliveryStamp::class);
+        $io->writeln(' Message history:');
+        foreach ($redeliveryStamps as $redeliveryStamp) {
+            $io->writeln(sprintf('  * Message failed and redelivered to the <info>%s</info> transport at <info>%s</info>', $redeliveryStamp->getSenderClassOrAlias(), $redeliveryStamp->getRedeliveredAt()->format('Y-m-d H:i:s')));
+        }
+        $io->newLine();
+
         if ($io->isVeryVerbose()) {
             $io->title('Message:');
             $dump = new Dumper($io);
             $io->writeln($dump($envelope->getMessage()));
             $io->title('Exception:');
-            $io->writeln($sentToFailureTransportStamp->getFlattenException()->getTraceAsString());
+            $io->writeln(null === $flattenException ? '(no data)' : $flattenException->getTraceAsString());
         } else {
             $io->writeln(' Re-run command with <info>-vv</info> to see more message & error details.');
         }

Command/FailedMessagesRetryCommand.php

@@ -154,7 +154,7 @@ private function runInteractive(SymfonyStyle $io, bool $shouldForce)
         }
 
         // avoid success message if nothing was processed
-        if (1 < $count) {
+        if (1 <= $count) {
             $io->success('All failed messages have been handled or removed!');
         }
     }

Command/FailedMessagesShowCommand.php

@@ -18,7 +18,7 @@
 use Symfony\Component\Console\Output\ConsoleOutputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
-use Symfony\Component\Messenger\Stamp\SentToFailureTransportStamp;
+use Symfony\Component\Messenger\Stamp\RedeliveryStamp;
 use Symfony\Component\Messenger\Transport\Receiver\ListableReceiverInterface;
 
 /**
@@ -83,14 +83,14 @@ private function listMessages(SymfonyStyle $io, int $max)
 
         $rows = [];
         foreach ($envelopes as $envelope) {
-            /** @var SentToFailureTransportStamp $sentToFailureTransportStamp */
-            $sentToFailureTransportStamp = $envelope->last(SentToFailureTransportStamp::class);
+            /** @var RedeliveryStamp|null $lastRedeliveryStamp */
+            $lastRedeliveryStamp = $envelope->last(RedeliveryStamp::class);
 
             $rows[] = [
                 $this->getMessageId($envelope),
                 \get_class($envelope->getMessage()),
-                null === $sentToFailureTransportStamp ? '' : $sentToFailureTransportStamp->getSentAt()->format('Y-m-d H:i:s'),
-                null === $sentToFailureTransportStamp ? '' : $sentToFailureTransportStamp->getExceptionMessage(),
+                null === $lastRedeliveryStamp ? '' : $lastRedeliveryStamp->getRedeliveredAt()->format('Y-m-d H:i:s'),
+                null === $lastRedeliveryStamp ? '' : $lastRedeliveryStamp->getExceptionMessage(),
             ];
         }
 

EventListener/SendFailedMessageToFailureTransportListener.php

@@ -16,9 +16,9 @@
 use Symfony\Component\Messenger\Event\WorkerMessageFailedEvent;
 use Symfony\Component\Messenger\Exception\HandlerFailedException;
 use Symfony\Component\Messenger\MessageBusInterface;
+use Symfony\Component\Messenger\Stamp\DelayStamp;
 use Symfony\Component\Messenger\Stamp\ReceivedStamp;
 use Symfony\Component\Messenger\Stamp\RedeliveryStamp;
-use Symfony\Component\Messenger\Stamp\SentStamp;
 use Symfony\Component\Messenger\Stamp\SentToFailureTransportStamp;
 use Symfony\Component\Messenger\Stamp\TransportMessageIdStamp;
 
@@ -51,11 +51,8 @@ public function onMessageFailed(WorkerMessageFailedEvent $event)
         $envelope = $event->getEnvelope();
 
         // avoid re-sending to the failed sender
-        foreach ($envelope->all(SentStamp::class) as $sentStamp) {
-            /** @var SentStamp $sentStamp */
-            if ($sentStamp->getSenderAlias() === $this->failureSenderAlias) {
-                return;
-            }
+        if (null !== $envelope->last(SentToFailureTransportStamp::class)) {
+            return;
         }
 
         // remove the received stamp so it's redelivered
@@ -67,8 +64,9 @@ public function onMessageFailed(WorkerMessageFailedEvent $event)
         $flattenedException = \class_exists(FlattenException::class) ? FlattenException::createFromThrowable($throwable) : null;
         $envelope = $envelope->withoutAll(ReceivedStamp::class)
             ->withoutAll(TransportMessageIdStamp::class)
-            ->with(new SentToFailureTransportStamp($throwable->getMessage(), $event->getReceiverName(), $flattenedException))
-            ->with(new RedeliveryStamp(0, $this->failureSenderAlias));
+            ->with(new SentToFailureTransportStamp($event->getReceiverName()))
+            ->with(new DelayStamp(0))
+            ->with(new RedeliveryStamp(0, $this->failureSenderAlias, $throwable->getMessage(), $flattenedException));
 
         if (null !== $this->logger) {
             $this->logger->info('Rejected message {class} will be sent to the failure transport {transport}.', [

Handler/MessageSubscriberInterface.php

@@ -32,13 +32,14 @@ interface MessageSubscriberInterface extends MessageHandlerInterface
      *     yield FirstMessage::class => ['priority' => 0];
      *     yield SecondMessage::class => ['priority => -10];
      *
-     * It can also specify a method, a priority and/or a bus per message:
+     * It can also specify a method, a priority, a bus and/or a transport per message:
      *
      *     yield FirstMessage::class => ['method' => 'firstMessageMethod'];
      *     yield SecondMessage::class => [
      *         'method' => 'secondMessageMethod',
      *         'priority' => 20,
      *         'bus' => 'my_bus_name',
+     *         'from_transport' => 'your_transport_name',
      *     ];
      *
      * The benefit of using `yield` instead of returning an array is that you can `yield` multiple times the

Middleware/FailedMessageProcessingMiddleware.php

@@ -0,0 +1,38 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Messenger\Middleware;
+
+use Symfony\Component\Messenger\Envelope;
+use Symfony\Component\Messenger\Stamp\ReceivedStamp;
+use Symfony\Component\Messenger\Stamp\SentToFailureTransportStamp;
+
+/**
+ * @author Ryan Weaver <ryan@symfonycasts.com>
+ *
+ * @experimental in 4.3
+ */
+class FailedMessageProcessingMiddleware implements MiddlewareInterface
+{
+    public function handle(Envelope $envelope, StackInterface $stack): Envelope
+    {
+        // look for "received" messages decorated with the SentToFailureTransportStamp
+        /** @var SentToFailureTransportStamp|null $sentToFailureStamp */
+        $sentToFailureStamp = $envelope->last(SentToFailureTransportStamp::class);
+        if (null !== $sentToFailureStamp && null !== $envelope->last(ReceivedStamp::class)) {
+            // mark the message as "received" from the original transport
+            // this guarantees the same behavior as when originally received
+            $envelope = $envelope->with(new ReceivedStamp($sentToFailureStamp->getOriginalReceiverName()));
+        }
+
+        return $stack->next()->handle($envelope, $stack);
+    }
+}

Middleware/SendMessageMiddleware.php

@@ -52,7 +52,6 @@ public function handle(Envelope $envelope, StackInterface $stack): Envelope
             'class' => \get_class($envelope->getMessage()),
         ];
 
-        $handle = false;
         $sender = null;
 
         try {
@@ -65,7 +64,7 @@ public function handle(Envelope $envelope, StackInterface $stack): Envelope
 
                 // dispatch event unless this is a redelivery
                 $shouldDispatchEvent = null === $redeliveryStamp;
-                foreach ($this->getSenders($envelope, $handle, $redeliveryStamp) as $alias => $sender) {
+                foreach ($this->getSenders($envelope, $redeliveryStamp) as $alias => $sender) {
                     if (null !== $this->eventDispatcher && $shouldDispatchEvent) {
                         $event = new SendMessageToTransportsEvent($envelope);
                         $this->eventDispatcher->dispatch($event);
@@ -76,14 +75,9 @@ public function handle(Envelope $envelope, StackInterface $stack): Envelope
                     $this->logger->info('Sending message "{class}" with "{sender}"', $context + ['sender' => \get_class($sender)]);
                     $envelope = $sender->send($envelope->with(new SentStamp(\get_class($sender), \is_string($alias) ? $alias : null)));
                 }
-
-                // on a redelivery, only send back to queue: never call local handlers
-                if (null !== $redeliveryStamp) {
-                    $handle = false;
-                }
             }
 
-            if (null === $sender || $handle) {
+            if (null === $sender) {
                 return $stack->next()->handle($envelope, $stack);
             }
         } catch (\Throwable $e) {
@@ -100,14 +94,14 @@ public function handle(Envelope $envelope, StackInterface $stack): Envelope
     /**
      * * @return iterable|SenderInterface[]
      */
-    private function getSenders(Envelope $envelope, &$handle, ?RedeliveryStamp $redeliveryStamp): iterable
+    private function getSenders(Envelope $envelope, ?RedeliveryStamp $redeliveryStamp): iterable
     {
         if (null !== $redeliveryStamp) {
             return [
                 $redeliveryStamp->getSenderClassOrAlias() => $this->sendersLocator->getSenderByAlias($redeliveryStamp->getSenderClassOrAlias()),
             ];
         }
 
-        return $this->sendersLocator->getSenders($envelope, $handle);
+        return $this->sendersLocator->getSenders($envelope);
     }
 }

RoutableMessageBus.php

@@ -28,13 +28,15 @@
 class RoutableMessageBus implements MessageBusInterface
 {
     private $busLocator;
+    private $fallbackBus;
 
     /**
      * @param ContainerInterface $busLocator A locator full of MessageBusInterface objects
      */
-    public function __construct(ContainerInterface $busLocator)
+    public function __construct(ContainerInterface $busLocator, MessageBusInterface $fallbackBus = null)
     {
         $this->busLocator = $busLocator;
+        $this->fallbackBus = $fallbackBus;
     }
 
     public function dispatch($envelope, array $stamps = []): Envelope
@@ -43,14 +45,28 @@ public function dispatch($envelope, array $stamps = []): Envelope
             throw new InvalidArgumentException('Messages passed to RoutableMessageBus::dispatch() must be inside an Envelope');
         }
 
-        /** @var BusNameStamp $busNameStamp */
+        return $this->getMessageBus($envelope)->dispatch($envelope, $stamps);
+    }
+
+    private function getMessageBus(Envelope $envelope): MessageBusInterface
+    {
+        /** @var BusNameStamp|null $busNameStamp */
         $busNameStamp = $envelope->last(BusNameStamp::class);
-        $busName = null !== $busNameStamp ? $busNameStamp->getBusName() : MessageBusInterface::class;
+
+        if (null === $busNameStamp) {
+            if (null === $this->fallbackBus) {
+                throw new InvalidArgumentException(sprintf('Envelope is missing a BusNameStamp and no fallback message bus is configured on RoutableMessageBus.'));
+            }
+
+            return $this->fallbackBus;
+        }
+
+        $busName = $busNameStamp->getBusName();
 
         if (!$this->busLocator->has($busName)) {
             throw new InvalidArgumentException(sprintf('Bus named "%s" does not exist.', $busName));
         }
 
-        return $this->busLocator->get($busName)->dispatch($envelope, $stamps);
+        return $this->busLocator->get($busName);
     }
 }

Stamp/RedeliveryStamp.php

@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\Messenger\Stamp;
 
+use Symfony\Component\Debug\Exception\FlattenException;
+
 /**
  * Stamp applied when a messages needs to be redelivered.
  *
@@ -20,14 +22,20 @@ class RedeliveryStamp implements StampInterface
 {
     private $retryCount;
     private $senderClassOrAlias;
+    private $redeliveredAt;
+    private $exceptionMessage;
+    private $flattenException;
 
     /**
      * @param string $senderClassOrAlias Alias from SendersLocator or just the class name
      */
-    public function __construct(int $retryCount, string $senderClassOrAlias)
+    public function __construct(int $retryCount, string $senderClassOrAlias, string $exceptionMessage = null, FlattenException $flattenException = null)
     {
         $this->retryCount = $retryCount;
         $this->senderClassOrAlias = $senderClassOrAlias;
+        $this->exceptionMessage = $exceptionMessage;
+        $this->flattenException = $flattenException;
+        $this->redeliveredAt = new \DateTimeImmutable();
     }
 
     public function getRetryCount(): int
@@ -36,12 +44,27 @@ public function getRetryCount(): int
     }
 
     /**
-     * Needed for this class to serialize through Symfony's serializer.
+     * The target sender this should be redelivered to.
      *
      * @internal
      */
     public function getSenderClassOrAlias(): string
     {
         return $this->senderClassOrAlias;
     }
+
+    public function getExceptionMessage(): ?string
+    {
+        return $this->exceptionMessage;
+    }
+
+    public function getFlattenException(): ?FlattenException
+    {
+        return $this->flattenException;
+    }
+
+    public function getRedeliveredAt(): \DateTimeInterface
+    {
+        return $this->redeliveredAt;
+    }
 }