symfony · sroze · May 7, 2018 · Apr 16, 2018 · yceruto · May 4, 2018
diff --git a/src/Symfony/Component/Messenger/Asynchronous/Middleware/SendMessageMiddleware.php b/src/Symfony/Component/Messenger/Asynchronous/Middleware/SendMessageMiddleware.php
@@ -13,12 +13,14 @@
 
 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>
  */
-class SendMessageMiddleware implements MiddlewareInterface
+class SendMessageMiddleware implements MiddlewareInterface, EnvelopeAwareInterface
 {
     private $senderLocator;
 
@@ -32,17 +34,19 @@ public function __construct(SenderLocatorInterface $senderLocator)
      */
     public function handle($message, callable $next)
     {
-        if ($message instanceof ReceivedMessage) {
-            return $next($message->getMessage());
+        $envelope = Envelope::wrap($message);
+        if ($envelope->get(ReceivedMessage::class)) {
+            // It's a received message. Do not send it back:
+            return $next($message);
         }
 
-        if (!empty($senders = $this->senderLocator->getSendersForMessage($message))) {
+        if (!empty($senders = $this->senderLocator->getSendersForMessage($envelope->getMessage()))) {
             foreach ($senders as $sender) {
                 if (null === $sender) {
                     continue;
                 }
 
-                $sender->send($message);
+                $sender->send($envelope);
             }
 
             if (!\in_array(null, $senders, true)) {

diff --git a/src/Symfony/Component/Messenger/Asynchronous/Transport/ReceivedMessage.php b/src/Symfony/Component/Messenger/Asynchronous/Transport/ReceivedMessage.php
@@ -12,26 +12,26 @@
 namespace Symfony\Component\Messenger\Asynchronous\Transport;
 
 use Symfony\Component\Messenger\Asynchronous\Middleware\SendMessageMiddleware;
+use Symfony\Component\Messenger\EnvelopeItemInterface;
 
 /**
- * Wraps a received message. This is mainly used by the `SendMessageMiddleware` middleware to identify
+ * Marker config for a received message.
+ * This is mainly used by the `SendMessageMiddleware` middleware to identify
  * a message should not be sent if it was just received.
  *
  * @see SendMessageMiddleware
  *
  * @author Samuel Roze <samuel.roze@gmail.com>
  */
-final class ReceivedMessage
+final class ReceivedMessage implements EnvelopeItemInterface
 {
-    private $message;
-
-    public function __construct($message)
+    public function serialize()
     {
-        $this->message = $message;
+        return '';
     }
 
-    public function getMessage()
+    public function unserialize($serialized)
     {
-        return $this->message;
+        // noop
     }
 }
diff --git a/src/Symfony/Component/Messenger/Asynchronous/Transport/WrapIntoReceivedMessage.php b/src/Symfony/Component/Messenger/Asynchronous/Transport/WrapIntoReceivedMessage.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Messenger\Asynchronous\Transport;
 
+use Symfony\Component\Messenger\Envelope;
 use Symfony\Component\Messenger\Transport\ReceiverInterface;
 
 /**
@@ -27,12 +28,12 @@ public function __construct(ReceiverInterface $decoratedConsumer)
 
     public function receive(callable $handler): void
     {
-        $this->decoratedReceiver->receive(function ($message) use ($handler) {
-            if (null !== $message) {
-                $message = new ReceivedMessage($message);
+        $this->decoratedReceiver->receive(function (?Envelope $envelope) use ($handler) {
+            if (null !== $envelope) {
+                $envelope = $envelope->with(new ReceivedMessage());
             }
 
-            $handler($message);
+            $handler($envelope);
         });
     }
 

diff --git a/src/Symfony/Component/Messenger/Envelope.php b/src/Symfony/Component/Messenger/Envelope.php
@@ -0,0 +1,80 @@
+<?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;
+
+/**
+ * A message wrapped in an envelope with items (configurations, markers, ...).
+ *
+ * @author Maxime Steinhausser <maxime.steinhausser@gmail.com>
+ *
+ * @experimental in 4.1
+ */
+final class Envelope
+{
+    private $items = array();
+    private $message;
+
+    /**
+     * @param object                  $message
+     * @param EnvelopeItemInterface[] $items
+     */
+    public function __construct($message, array $items = array())
+    {
+        $this->message = $message;
+        foreach ($items as $item) {
+            $this->items[\get_class($item)] = $item;
+        }
+    }
+
+    /**
+     * Wrap a message into an envelope if not already wrapped.
+     *
+     * @param Envelope|object $message
+     */
+    public static function wrap($message): self
+    {
+        return $message instanceof self ? $message : new self($message);
+    }
+
+    /**
+     * @return Envelope a new Envelope instance with additional item
+     */
+    public function with(EnvelopeItemInterface $item): self
+    {
+        $cloned = clone $this;
+
+        $cloned->items[\get_class($item)] = $item;
+
+        return $cloned;
+    }
+
+    public function get(string $itemFqcn): ?EnvelopeItemInterface
+    {
+        return $this->items[$itemFqcn] ?? null;
+    }
+
+    /**
+     * @return EnvelopeItemInterface[] indexed by fqcn
+     */
+    public function all(): array
+    {
+        return $this->items;
+    }
+
+    /**
+     * @return object The original message contained in the envelope
+     */
+    public function getMessage()
+    {
+        return $this->message;
+    }
+}
diff --git a/src/Symfony/Component/Messenger/EnvelopeAwareInterface.php b/src/Symfony/Component/Messenger/EnvelopeAwareInterface.php
@@ -0,0 +1,23 @@
+<?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;
+
+/**
+ * A Messenger protagonist aware of the message envelope and its content.
+ *
+ * @author Maxime Steinhausser <maxime.steinhausser@gmail.com>
+ *
+ * @experimental in 4.1
+ */
+interface EnvelopeAwareInterface
+{
+}
diff --git a/src/Symfony/Component/Messenger/EnvelopeItemInterface.php b/src/Symfony/Component/Messenger/EnvelopeItemInterface.php
@@ -0,0 +1,24 @@
+<?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;
+
+/**
+ * An envelope item related to a message.
+ * This item must be serializable for transport.
+ *
+ * @author Maxime Steinhausser <maxime.steinhausser@gmail.com>
+ *
+ * @experimental in 4.1
+ */
+interface EnvelopeItemInterface extends \Serializable
+{
+}
diff --git a/src/Symfony/Component/Messenger/MessageBus.php b/src/Symfony/Component/Messenger/MessageBus.php
@@ -55,6 +55,12 @@ private function callableForNextMiddleware(int $index): callable
         $middleware = $this->indexedMiddlewares[$index];
 
         return function ($message) use ($middleware, $index) {
+            $message = Envelope::wrap($message);
+            if (!$middleware instanceof EnvelopeAwareInterface) {
+                // Do not provide the envelope if the middleware cannot read it:
+                $message = $message->getMessage();
+            }
+
             return $middleware->handle($message, $this->callableForNextMiddleware($index + 1));
         };
     }

diff --git a/src/Symfony/Component/Messenger/MessageBusInterface.php b/src/Symfony/Component/Messenger/MessageBusInterface.php
@@ -23,7 +23,7 @@ interface MessageBusInterface
      *
      * The bus can return a value coming from handlers, but is not required to do so.
      *
-     * @param object $message
+     * @param object|Envelope $message The message or the message pre-wrapped in an envelope
      *
      * @return mixed
      */

diff --git a/src/Symfony/Component/Messenger/Middleware/Configuration/ValidationConfiguration.php b/src/Symfony/Component/Messenger/Middleware/Configuration/ValidationConfiguration.php
@@ -0,0 +1,58 @@
+<?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\Configuration;
+
+use Symfony\Component\Messenger\EnvelopeItemInterface;
+use Symfony\Component\Validator\Constraints\GroupSequence;
+
+/**
+ * @author Maxime Steinhausser <maxime.steinhausser@gmail.com>
+ *
+ * @experimental in 4.1
+ */
+final class ValidationConfiguration implements EnvelopeItemInterface
+{
+    private $groups;
+
+    /**
+     * @param string[]|GroupSequence $groups
+     */
+    public function __construct($groups)
+    {
+        $this->groups = $groups;
+    }
+
+    public function getGroups()
+    {
+        return $this->groups;
+    }
+
+    public function serialize()
+    {
+        $isGroupSequence = $this->groups instanceof GroupSequence;
+
+        return serialize(array(
+            'groups' => $isGroupSequence ? $this->groups->groups : $this->groups,
+            'is_group_sequence' => $isGroupSequence,
+        ));
+    }
+
+    public function unserialize($serialized)
+    {
+        list(
+            'groups' => $groups,
+            'is_group_sequence' => $isGroupSequence
+        ) = unserialize($serialized, array('allowed_classes' => false));
+
+        $this->__construct($isGroupSequence ? new GroupSequence($groups) : $groups);
+    }
+}
diff --git a/src/Symfony/Component/Messenger/Middleware/LoggingMiddleware.php b/src/Symfony/Component/Messenger/Middleware/LoggingMiddleware.php
@@ -11,7 +11,6 @@
 
 namespace Symfony\Component\Messenger\Middleware;
 
-use Symfony\Component\Messenger\Asynchronous\Transport\ReceivedMessage;
 use Psr\Log\LoggerInterface;
 
 /**
@@ -51,10 +50,6 @@ public function handle($message, callable $next)
 
     private function createContext($message): array
     {
-        if ($message instanceof ReceivedMessage) {
-            $message = $message->getMessage();
-        }
-
         return array(
             'message' => $message,
             'class' => \get_class($message),

diff --git a/src/Symfony/Component/Messenger/Middleware/ValidationMiddleware.php b/src/Symfony/Component/Messenger/Middleware/ValidationMiddleware.php
@@ -11,13 +11,16 @@
 
 namespace Symfony\Component\Messenger\Middleware;
 
+use Symfony\Component\Messenger\Envelope;
+use Symfony\Component\Messenger\EnvelopeAwareInterface;
 use Symfony\Component\Messenger\Exception\ValidationFailedException;
+use Symfony\Component\Messenger\Middleware\Configuration\ValidationConfiguration;
 use Symfony\Component\Validator\Validator\ValidatorInterface;
 
 /**
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  */
-class ValidationMiddleware implements MiddlewareInterface
+class ValidationMiddleware implements MiddlewareInterface, EnvelopeAwareInterface
 {
     private $validator;
 
@@ -28,9 +31,17 @@ public function __construct(ValidatorInterface $validator)
 
     public function handle($message, callable $next)
     {
-        $violations = $this->validator->validate($message);
+        $envelope = Envelope::wrap($message);
+        $subject = $envelope->getMessage();
+        $groups = null;
+        /** @var ValidationConfiguration|null $validationConfig */
+        if ($validationConfig = $envelope->get(ValidationConfiguration::class)) {
+            $groups = $validationConfig->getGroups();
+        }
+
+        $violations = $this->validator->validate($subject, null, $groups);
         if (\count($violations)) {
-            throw new ValidationFailedException($message, $violations);
+            throw new ValidationFailedException($subject, $violations);
         }
 
         return $next($message);