[Messenger] use Envelope internally, return void, add EnvelopeHandler…

…Interface and other cleanups
symfony · nicolas-grekas · Oct 17, 2018 · Oct 17, 2018 · Oct 17, 2018 · Oct 15, 2018
commit f80cbca924e565bb18254b7b0521d89221aa45a4
diff --git a/src/Symfony/Component/Messenger/Asynchronous/Middleware/SendMessageMiddleware.php b/src/Symfony/Component/Messenger/Asynchronous/Middleware/SendMessageMiddleware.php
@@ -15,14 +15,13 @@
 use Symfony\Component\Messenger\Asynchronous\Routing\SenderLocatorInterface;
 use Symfony\Component\Messenger\Asynchronous\Transport\ReceivedMessage;
 use Symfony\Component\Messenger\Envelope;
-use Symfony\Component\Messenger\EnvelopeAwareInterface;
 use Symfony\Component\Messenger\Middleware\MiddlewareInterface;
 
 /**
  * @author Samuel Roze <samuel.roze@gmail.com>
  * @author Tobias Schultze <http://tobion.de>
  */
-class SendMessageMiddleware implements MiddlewareInterface, EnvelopeAwareInterface
+class SendMessageMiddleware implements MiddlewareInterface
 {
     private $senderLocator;
     private $messagesToSendAndHandleMapping;
@@ -34,11 +33,9 @@ public function __construct(SenderLocatorInterface $senderLocator, array $messag
     }
 
     /**
-     * @param Envelope $envelope
-     *
      * {@inheritdoc}
      */
-    public function handle($envelope, callable $next): void
+    public function handle(Envelope $envelope, callable $next): void
     {
         if ($envelope->get(ReceivedMessage::class)) {
             // It's a received message. Do not send it back:

diff --git a/src/Symfony/Component/Messenger/Asynchronous/Routing/AbstractSenderLocator.php b/src/Symfony/Component/Messenger/Asynchronous/Routing/AbstractSenderLocator.php
@@ -22,6 +22,12 @@ abstract class AbstractSenderLocator implements SenderLocatorInterface
 {
     public static function getValueFromMessageRouting(array $mapping, Envelope $envelope)
     {
+        $name = $envelope->getMessageName();
+
+        if (null !== $name && isset($mapping[$name])) {
+            return $mapping[$name];
+        }
+
         if (isset($mapping[$class = \get_class($envelope->getMessage())])) {
             return $mapping[$class];
         }

diff --git a/src/Symfony/Component/Messenger/Asynchronous/Routing/SenderLocator.php b/src/Symfony/Component/Messenger/Asynchronous/Routing/SenderLocator.php
@@ -38,7 +38,7 @@ public function getSender(Envelope $envelope): ?SenderInterface
         }
 
         if (!$sender instanceof SenderInterface) {
-            throw new RuntimeException(sprintf('The sender instance provided for message "%s" should be of type "%s" but got "%s".', \get_class($envelope->getMessage()), SenderInterface::class, \is_object($sender) ? \get_class($sender) : \gettype($sender)));
+            throw new RuntimeException(sprintf('The sender instance provided for message "%s" should be of type "%s" but got "%s".', $envelope->getMessageName() ?? \get_class($envelope->getMessage()), SenderInterface::class, \is_object($sender) ? \get_class($sender) : \gettype($sender)));
         }
 
         return $sender;

diff --git a/src/Symfony/Component/Messenger/Envelope.php b/src/Symfony/Component/Messenger/Envelope.php
@@ -41,9 +41,15 @@ public function __construct($message, array $items = array())
      *
      * @param Envelope|object $message
      */
-    public static function wrap($message): self
+    public static function wrap($message, string $name = null): self
     {
-        return $message instanceof self ? $message : new self($message);
+        $envelope = $message instanceof self ? clone $message : new self($message);
+        if (null !== $name) {
+            return $envelope->with(new MessageConfiguration($name));
+        }
+        unset($envelope->items[MessageConfiguration::class]);
+
+        return $envelope;
     }
 
     /**
@@ -58,15 +64,6 @@ public function with(EnvelopeItemInterface $item): self
         return $cloned;
     }
 
-    public function withMessage($message): self
-    {
-        $cloned = clone $this;
-
-        $cloned->message = $message;
-
-        return $cloned;
-    }
-
     public function get(string $itemFqcn): ?EnvelopeItemInterface
     {
         return $this->items[$itemFqcn] ?? null;
@@ -88,14 +85,10 @@ public function getMessage()
         return $this->message;
     }
 
-    /**
-     * @param object $target
-     *
-     * @return Envelope|object The original message or the envelope if the target supports it
-     *                         (i.e implements {@link EnvelopeAwareInterface}).
-     */
-    public function getMessageFor($target)
+    public function getMessageName(): ?string
     {
-        return $target instanceof EnvelopeAwareInterface ? $this : $this->message;
+        $config = $this->items[MessageConfiguration::class] ?? null;
+
+        return $config ? $config->getName() : null;
     }
 }
diff --git a/src/Symfony/Component/Messenger/EnvelopeAwareInterface.php b/src/Symfony/Component/Messenger/EnvelopeAwareInterface.php
diff --git a/src/Symfony/Component/Messenger/Handler/ChainHandler.php b/src/Symfony/Component/Messenger/Handler/ChainHandler.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Messenger\Handler;
 
+use Symfony\Component\Messenger\Envelope;
 use Symfony\Component\Messenger\Exception\InvalidArgumentException;
 
 /**
@@ -37,8 +38,10 @@ public function __construct(array $handlers)
         $this->handlers = $handlers;
     }
 
-    public function __invoke($message)
+    public function __invoke(Envelope $envelope)
     {
+        $message = $envelope->getMessage();
+
         foreach ($this->handlers as $handler) {
             $handler($message);
         }

diff --git a/src/Symfony/Component/Messenger/Handler/Locator/AbstractHandlerLocator.php b/src/Symfony/Component/Messenger/Handler/Locator/AbstractHandlerLocator.php
@@ -24,6 +24,11 @@ abstract class AbstractHandlerLocator implements HandlerLocatorInterface
 {
     public function getHandler(Envelope $envelope, bool $allowNoHandler = false): ?callable
     {
+        $name = $envelope->getMessageName();
+
+        if (null !== $name && $handler = $this->getHandlerByName($name)) {
+            return $handler;
        }
         $class = \get_class($envelope->getMessage());
 
         if ($handler = $this->getHandlerByName($class)) {

diff --git a/src/Symfony/Component/Messenger/MessageBus.php b/src/Symfony/Component/Messenger/MessageBus.php
@@ -39,7 +39,7 @@ public function __construct(iterable $middlewareHandlers = array())
     /**
      * {@inheritdoc}
      */
-    public function dispatch($message): void
+    public function dispatch($message, string $name = null): void
     {
         if (!\is_object($message)) {
             throw new \TypeError(sprintf('Invalid argument provided to "%s()": expected object, but got %s.', __METHOD__, \gettype($message)));
@@ -48,34 +48,15 @@ public function dispatch($message): void
         $middlewareIterator = $this->middlewareAggregate->getIterator();
 
         foreach ($middlewareIterator as $middleware) {
-            $currentEnvelope = Envelope::wrap($message);
-
-            // Do not provide the envelope if the middleware cannot read it:
-            $message = $middleware instanceof EnvelopeAwareInterface ? $currentEnvelope : $currentEnvelope->getMessage();
-
-            $next = static function ($message) use ($middlewareIterator, &$currentEnvelope, &$next) {
+            $next = static function ($envelope) use ($middlewareIterator, &$next) {
                 $middlewareIterator->next();
 
-                if (!$middlewareIterator->valid()) {
-                    return;
-                }
-
-                $middleware = $middlewareIterator->current();
-
-                if ($message instanceof Envelope) {
-                    $currentEnvelope = $message;
-                } else {
-                    $message = $currentEnvelope->withMessage($message);
-                }
-
-                if (!$middleware instanceof EnvelopeAwareInterface) {
-                    $message = $message->getMessage();
+                if ($middlewareIterator->valid()) {
+                    $middlewareIterator->current()->handle($envelope, $next);
                 }
-
-                $middleware->handle($message, $next);
             };
 
-            $middleware->handle($message, $next);
+            $middleware->handle(Envelope::wrap($message), $next);
         }
     }
 }
diff --git a/src/Symfony/Component/Messenger/MessageBusInterface.php b/src/Symfony/Component/Messenger/MessageBusInterface.php
@@ -20,6 +20,8 @@ interface MessageBusInterface
      * Dispatches the given message.
      *
      * @param object|Envelope $message The message or the message pre-wrapped in an envelope
+     * @param string|null     $name    The name to use as dispatching key; when not provided,
+     *                                 this name is derived from the type of the message
      */
-    public function dispatch($message): void;
+    public function dispatch($message, string $name = null): void;
 }
diff --git a/src/Symfony/Component/Messenger/MessageConfiguration.php b/src/Symfony/Component/Messenger/MessageConfiguration.php
@@ -0,0 +1,30 @@
+<?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;
+
+/**
+ * @author Nicolas Grekas <p@tchwork.com>
+ */
+final class MessageConfiguration implements EnvelopeItemInterface
+{
+    private $name;
+
+    public function __construct(string $name)
+    {
+        $this->name = $name;
+    }
+
+    public function getName(): string
+    {
+        return $this->name;
+    }
+}
diff --git a/src/Symfony/Component/Messenger/Middleware/AllowNoHandlerMiddleware.php b/src/Symfony/Component/Messenger/Middleware/AllowNoHandlerMiddleware.php
diff --git a/src/Symfony/Component/Messenger/Middleware/Enhancers/ActivationMiddlewareDecorator.php b/src/Symfony/Component/Messenger/Middleware/Enhancers/ActivationMiddlewareDecorator.php
@@ -12,15 +12,14 @@
 namespace Symfony\Component\Messenger\Middleware\Enhancers;
 
 use Symfony\Component\Messenger\Envelope;
-use Symfony\Component\Messenger\EnvelopeAwareInterface;
 use Symfony\Component\Messenger\Middleware\MiddlewareInterface;
 
 /**
  * Execute the inner middleware according to an activation strategy.
  *
  * @author Maxime Steinhausser <maxime.steinhausser@gmail.com>
  */
-class ActivationMiddlewareDecorator implements MiddlewareInterface, EnvelopeAwareInterface
+class ActivationMiddlewareDecorator implements MiddlewareInterface
 {
     private $inner;
     private $activated;
@@ -35,12 +34,12 @@ public function __construct(MiddlewareInterface $inner, $activated)
     }
 
     /**
-     * @param Envelope $envelope
+     * {@inheritdoc}
      */
-    public function handle($envelope, callable $next): void
+    public function handle(Envelope $envelope, callable $next): void
     {
         if (\is_callable($this->activated) ? ($this->activated)($envelope) : $this->activated) {
-            $this->inner->handle($envelope->getMessageFor($this->inner), $next);
+            $this->inner->handle($envelope, $next);
         } else {
             $next($envelope);
         }

diff --git a/src/Symfony/Component/Messenger/Middleware/Enhancers/TraceableMiddleware.php b/src/Symfony/Component/Messenger/Middleware/Enhancers/TraceableMiddleware.php
@@ -12,7 +12,6 @@
 namespace Symfony\Component\Messenger\Middleware\Enhancers;
 
 use Symfony\Component\Messenger\Envelope;
-use Symfony\Component\Messenger\EnvelopeAwareInterface;
 use Symfony\Component\Messenger\Middleware\MiddlewareInterface;
 use Symfony\Component\Stopwatch\Stopwatch;
 
@@ -21,7 +20,7 @@
  *
  * @author Maxime Steinhausser <maxime.steinhausser@gmail.com>
  */
-class TraceableMiddleware implements MiddlewareInterface, EnvelopeAwareInterface
+class TraceableMiddleware implements MiddlewareInterface
 {
     private $inner;
     private $stopwatch;
@@ -37,9 +36,9 @@ public function __construct(MiddlewareInterface $inner, Stopwatch $stopwatch, st
     }
 
     /**
-     * @param Envelope $envelope
+     * {@inheritdoc}
      */
-    public function handle($envelope, callable $next): void
+    public function handle(Envelope $envelope, callable $next): void
     {
         $class = \get_class($this->inner);
         $eventName = 'c' === $class[0] && 0 === strpos($class, "class@anonymous\0") ? get_parent_class($class).'@anonymous' : $class;
@@ -51,9 +50,9 @@ public function handle($envelope, callable $next): void
         $this->stopwatch->start($eventName, $this->eventCategory);
 
         try {
-            $this->inner->handle($envelope->getMessageFor($this->inner), function ($message) use ($next, $eventName) {
+            $this->inner->handle($envelope, fu
F54E
nction (Envelope $envelope) use ($next, $eventName) {
                 $this->stopwatch->stop($eventName);
-                $next($message);
+                $next($envelope);
                 $this->stopwatch->start($eventName, $this->eventCategory);
             });
         } finally {

diff --git a/src/Symfony/Component/Messenger/Middleware/HandleMessageMiddleware.php b/src/Symfony/Component/Messenger/Middleware/HandleMessageMiddleware.php
@@ -12,28 +12,26 @@
 namespace Symfony\Component\Messenger\Middleware;
 
 use Symfony\Component\Messenger\Envelope;
-use Symfony\Component\Messenger\EnvelopeAwareInterface;
 use Symfony\Component\Messenger\Handler\Locator\HandlerLocatorInterface;
 
 /**
  * @author Samuel Roze <samuel.roze@gmail.com>
  */
-class HandleMessageMiddleware implements MiddlewareInterface, EnvelopeAwareInterface
+class HandleMessageMiddleware implements MiddlewareInterface
 {
     private $messageHandlerLocator;
 
-    public function __construct(HandlerLocatorInterface $messageHandlerLocator)
+    public function __construct(HandlerLocatorInterface $messageHandlerLocator, bool $allowNoHandler = false)
     {
         $this->messageHandlerLocator = $messageHandlerLocator;
+        $this->allowNoHandler = $allowNoHandler;
     }
 
-    /**
-     * @param Envelope $envelope
-     */
-    public function handle($envelope, callable $next): void
+    public function handle(Envelope $envelope, callable $next): void
     {
-        $handler = $this->messageHandlerLocator->getHandler($envelope);
-        $handler($envelope->getMessage());
+        if ($handler = $this->messageHandlerLocator->getHandler($envelope, $this->allowNoHandler)) {
+            $handler($envelope->getMessage());
+        }
 
         $next($envelope);
     }