[Messenger] EnvelopeItemInterface::isTransportable(): bool

ogizanagi · ogizanagi · commit c17ea71f49fc · 2018-05-06T12:51:29.000+02:00
diff --git a/src/Symfony/Component/Messenger/Asynchronous/Middleware/SendMessageMiddleware.php b/src/Symfony/Component/Messenger/Asynchronous/Middleware/SendMessageMiddleware.php
@@ -15,6 +15,7 @@
 use Symfony\Component\Messenger\Asynchronous\Transport\ReceivedMessage;
 use Symfony\Component\Messenger\Envelope;
 use Symfony\Component\Messenger\EnvelopeAwareInterface;
+use Symfony\Component\Messenger\EnvelopeItemInterface;
 use Symfony\Component\Messenger\Middleware\MiddlewareInterface;
 
 /**
@@ -40,6 +41,10 @@ public function handle($message, callable $next)
             return $next($message);
         }
 
+        $envelope = new Envelope($envelope->getMessage(), array_filter($envelope->all(), function (EnvelopeItemInterface $item): bool {
+            return $item->isTransportable();
+        }));
+
         if (!empty($senders = $this->senderLocator->getSendersForMessage($envelope->getMessage()))) {
             foreach ($senders as $sender) {
                 if (null === $sender) {
diff --git a/src/Symfony/Component/Messenger/Asynchronous/Transport/ReceivedMessage.php b/src/Symfony/Component/Messenger/Asynchronous/Transport/ReceivedMessage.php
@@ -25,13 +25,11 @@
  */
 final class ReceivedMessage implements EnvelopeItemInterface
 {
-    public function serialize()
+    /**
+     * {@inheritdoc}
+     */
+    public function isTransportable(): bool
     {
-        return '';
-    }
-
-    public function unserialize($serialized)
-    {
-        // noop
+        return false;
     }
 }
diff --git a/src/Symfony/Component/Messenger/EnvelopeItemInterface.php b/src/Symfony/Component/Messenger/EnvelopeItemInterface.php
@@ -13,12 +13,15 @@
 
 /**
  * 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
+interface EnvelopeItemInterface
 {
+    /**
+     * @return bool True if this item can be transported. Otherwise, it'll be ignored during send.
+     */
+    public function isTransportable(): bool;
 }
diff --git a/src/Symfony/Component/Messenger/Middleware/Configuration/ValidationConfiguration.php b/src/Symfony/Component/Messenger/Middleware/Configuration/ValidationConfiguration.php
@@ -19,7 +19,7 @@
  *
  * @experimental in 4.1
  */
-final class ValidationConfiguration implements EnvelopeItemInterface
+final class ValidationConfiguration implements EnvelopeItemInterface, \Serializable
 {
     private $groups;
 
@@ -36,6 +36,14 @@ public function getGroups()
         return $this->groups;
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function isTransportable(): bool
+    {
+        return true;
+    }
+
     public function serialize()
     {
         $isGroupSequence = $this->groups instanceof GroupSequence;
diff --git a/src/Symfony/Component/Messenger/Tests/Asynchronous/Middleware/SendMessageMiddlewareTest.php b/src/Symfony/Component/Messenger/Tests/Asynchronous/Middleware/SendMessageMiddlewareTest.php
@@ -16,6 +16,7 @@
 use Symfony\Component\Messenger\Asynchronous\Routing\SenderLocatorInterface;
 use Symfony\Component\Messenger\Asynchronous\Transport\ReceivedMessage;
 use Symfony\Component\Messenger\Envelope;
+use Symfony\Component\Messenger\EnvelopeItemInterface;
 use Symfony\Component\Messenger\Tests\Fixtures\DummyMessage;
 use Symfony\Component\Messenger\Transport\SenderInterface;
 
@@ -37,6 +38,27 @@ public function testItSendsTheMessageToAssignedSender()
         $middleware->handle($message, $next);
     }
 
+    public function testItSendsEnvelopeWithTransportableItemsOnly()
+    {
+        $envelope = Envelope::wrap(new DummyMessage('Hey'))
+            ->with(new TransportableItem())
+            ->with(new NonTransportableItem())
+        ;
+        $sender = $this->getMockBuilder(SenderInterface::class)->getMock();
+        $next = $this->createPartialMock(\stdClass::class, array('__invoke'));
+
+        $middleware = new SendMessageMiddleware(new InMemorySenderLocator(array(
+            $sender,
+        )));
+
+        $sender->expects($this->once())->method('send')->with(Envelope::wrap(new DummyMessage('Hey'))
+            ->with(new TransportableItem())
+        );
+        $next->expects($this->never())->method($this->anything());
+
+        $middleware->handle($envelope, $next);
+    }
+
     public function testItSendsTheMessageToAssignedSenderWithPreWrappedMessage()
     {
         $envelope = Envelope::wrap(new DummyMessage('Hey'));
@@ -114,3 +136,19 @@ public function getSendersForMessage($message): array
         return $this->senders;
     }
 }
+
+class TransportableItem implements EnvelopeItemInterface
+{
+    public function isTransportable(): bool
+    {
+        return true;
+    }
+}
+
+class NonTransportableItem implements EnvelopeItemInterface
+{
+    public function isTransportable(): bool
+    {
+        return false;
+    }
+}
diff --git a/src/Symfony/Component/Messenger/Transport/Serialization/Serializer.php b/src/Symfony/Component/Messenger/Transport/Serialization/Serializer.php
@@ -68,8 +68,8 @@ public function encode(Envelope $envelope): array
         }
 
         $headers = array('type' => \get_class($envelope->getMessage()));
-        if ($configurations = $envelope->all()) {
-            $headers['X-Message-Envelope-Items'] = serialize($configurations);
+        if ($items = $envelope->all()) {
+            $headers['X-Message-Envelope-Items'] = serialize($items);
         }
 
         return array(
diff --git a/src/Symfony/Component/Messenger/Transport/Serialization/SerializerConfiguration.php b/src/Symfony/Component/Messenger/Transport/Serialization/SerializerConfiguration.php
@@ -18,7 +18,7 @@
  *
  * @experimental in 4.1
  */
-final class SerializerConfiguration implements EnvelopeItemInterface
+final class SerializerConfiguration implements EnvelopeItemInterface, \Serializable
 {
     private $context;
 
@@ -32,6 +32,14 @@ public function getContext(): array
         return $this->context;
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function isTransportable(): bool
+    {
+        return true;
+    }
+
     public function serialize()
     {
         return serialize(array('context' => $this->context));

Original file line number	Diff line number	Diff line change
`@@ -25,13 +25,11 @@`
`25`	`25`	`*/`
`26`	`26`	`final class ReceivedMessage implements EnvelopeItemInterface`
`27`	`27`	`{`
`28`		`- public function serialize()`
	`28`	`+ /**`
	`29`	`+ * {@inheritdoc}`
	`30`	`+ */`
	`31`	`+ public function isTransportable(): bool`
`29`	`32`	`{`
`30`		`- return '';`
`31`		`- }`
`32`		`-`
`33`		`- public function unserialize($serialized)`
`34`		`- {`
`35`		`- // noop`
	`33`	`+ return false;`
`36`	`34`	`}`
`37`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,12 +13,15 @@`
`13`	`13`
`14`	`14`	`/**`
`15`	`15`	`* An envelope item related to a message.`
`16`		`- * This item must be serializable for transport.`
`17`	`16`	`*`
`18`	`17`	`* @author Maxime Steinhausser <maxime.steinhausser@gmail.com>`
`19`	`18`	`*`
`20`	`19`	`* @experimental in 4.1`
`21`	`20`	`*/`
`22`		`-interface EnvelopeItemInterface extends \Serializable`
	`21`	`+interface EnvelopeItemInterface`
`23`	`22`	`{`
	`23`	`+ /**`
	`24`	`+ * @return bool True if this item can be transported. Otherwise, it'll be ignored during send.`
	`25`	`+ */`
	`26`	`+ public function isTransportable(): bool;`
`24`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`*`
`20`	`20`	`* @experimental in 4.1`
`21`	`21`	`*/`
`22`		`-final class ValidationConfiguration implements EnvelopeItemInterface`
	`22`	`+final class ValidationConfiguration implements EnvelopeItemInterface, \Serializable`
`23`	`23`	`{`
`24`	`24`	`private $groups;`
`25`	`25`
`@@ -36,6 +36,14 @@ public function getGroups()`
`36`	`36`	`return $this->groups;`
`37`	`37`	`}`
`38`	`38`
	`39`	`+ /**`
	`40`	`+ * {@inheritdoc}`
	`41`	`+ */`
	`42`	`+ public function isTransportable(): bool`
	`43`	`+ {`
	`44`	`+ return true;`
	`45`	`+ }`
	`46`	`+`
`39`	`47`	`public function serialize()`
`40`	`48`	`{`
`41`	`49`	`$isGroupSequence = $this->groups instanceof GroupSequence;`
Original file line number	Diff line number	Diff line change
`@@ -68,8 +68,8 @@ public function encode(Envelope $envelope): array`
`68`	`68`	`}`
`69`	`69`
`70`	`70`	`$headers = array('type' => \get_class($envelope->getMessage()));`
`71`		`- if ($configurations = $envelope->all()) {`
`72`		`- $headers['X-Message-Envelope-Items'] = serialize($configurations);`
	`71`	`+ if ($items = $envelope->all()) {`
	`72`	`+ $headers['X-Message-Envelope-Items'] = serialize($items);`
`73`	`73`	`}`
`74`	`74`
`75`	`75`	`return array(`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@`
`18`	`18`	`*`
`19`	`19`	`* @experimental in 4.1`
`20`	`20`	`*/`
`21`		`-final class SerializerConfiguration implements EnvelopeItemInterface`
	`21`	`+final class SerializerConfiguration implements EnvelopeItemInterface, \Serializable`
`22`	`22`	`{`
`23`	`23`	`private $context;`
`24`	`24`
`@@ -32,6 +32,14 @@ public function getContext(): array`
`32`	`32`	`return $this->context;`
`33`	`33`	`}`
`34`	`34`
	`35`	`+ /**`
	`36`	`+ * {@inheritdoc}`
	`37`	`+ */`
	`38`	`+ public function isTransportable(): bool`
	`39`	`+ {`
	`40`	`+ return true;`
	`41`	`+ }`
	`42`	`+`
`35`	`43`	`public function serialize()`
`36`	`44`	`{`
`37`	`45`	`return serialize(array('context' => $this->context));`