Adding a middleware to allow you to "hook into" the stamping process

symfony · weaverryan · Mar 22, 2019 · Mar 22, 2019 · aa0e880f87304d9cbee1c5ac15a91bfa8f6fe399 · OskarStark
commit aa0e880f87304d9cbee1c5ac15a91bfa8f6fe399
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -76,6 +76,7 @@
 use Symfony\Component\Messenger\Handler\MessageHandlerInterface;
 use Symfony\Component\Messenger\MessageBus;
 use Symfony\Component\Messenger\MessageBusInterface;
+use Symfony\Component\Messenger\Middleware\Stamper\EnvelopeStamperInterface;
 use Symfony\Component\Messenger\Transport\Serialization\SerializerInterface;
 use Symfony\Component\Messenger\Transport\TransportFactoryInterface;
 use Symfony\Component\Messenger\Transport\TransportInterface;
@@ -398,6 +399,8 @@ public function load(array $configs, ContainerBuilder $container)
            ->addTag('messenger.message_handler');
        $container->registerForAutoconfiguration(TransportFactoryInterface::class)
            ->addTag('messenger.transport_factory');
+        $container->registerForAutoconfiguration(EnvelopeStamperInterface::class)
+            ->addTag('messenger.envelope_stamper');
        $container->registerForAutoconfiguration(MimeTypeGuesserInterface::class)
            ->addTag('mime.mime_type_guesser');
        $container->registerForAutoconfiguration(LoggerAwareInterface::class)
@@ -1616,8 +1619,14 @@ private function registerMessengerConfiguration(array $config, ContainerBuilder
        }

        $defaultMiddleware = [
-            'before' => [['id' => 'dispatch_after_current_bus']],
-            'after' => [['id' => 'send_message'], ['id' => 'handle_message']],
+            'before' => [
+                ['id' => 'envelope_stamper_middleware'],
+                ['id' => 'dispatch_after_current_bus'],
+            ],
+            'after' => [
+                ['id' => 'send_message'],
+                ['id' => 'handle_message'],
+            ],
        ];
        foreach ($config['buses'] as $busId => $bus) {
            $middleware = $bus['middleware'];

diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/messenger.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/messenger.xml
@@ -41,6 +41,10 @@

        <service id="messenger.middleware.dispatch_after_current_bus" class="Symfony\Component\Messenger\Middleware\DispatchAfterCurrentBusMiddleware" />

+        <service id="messenger.middleware.envelope_stamper_middleware" class="Symfony\Component\Messenger\Middleware\EnvelopeStamperMiddleware">
+            <argument type="tagged" tag="messenger.envelope_stamper" />
+        </service>
+
        <service id="messenger.middleware.validation" class="Symfony\Component\Messenger\Middleware\ValidationMiddleware">
            <argument type="service" id="validator" />
        </service>

diff --git a/src/Symfony/Component/Messenger/Middleware/EnvelopeStamperMiddleware.php b/src/Symfony/Component/Messenger/Middleware/EnvelopeStamperMiddleware.php
@@ -0,0 +1,40 @@
+<?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\Middleware\Stamper\EnvelopeStamperInterface;
+
+/**
+ * @author Ryan Weaver <ryan@symfonycasts.com>
+ */
+class EnvelopeStamperMiddleware implements MiddlewareInterface
+{
+    private $envelopeStampers;
+
+    /**
+     * @param EnvelopeStamperInterface[] $envelopeStampers
+     */
+    public function __construct(iterable $envelopeStampers)
+    {
+        $this->envelopeStampers = $envelopeStampers;
+    }
+
+    public function handle(Envelope $envelope, StackInterface $stack): Envelope
+    {
+        foreach ($this->envelopeStampers as $envelopeStamper) {
+            $envelope = $envelopeStamper->stampEnvelope($envelope);
+        }
+
+        return $stack->next()->handle($envelope, $stack);
+    }
+}
diff --git a/src/Symfony/Component/Messenger/Middleware/Stamper/EnvelopeStamperInterface.php b/src/Symfony/Component/Messenger/Middleware/Stamper/EnvelopeStamperInterface.php
@@ -0,0 +1,27 @@
+<?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\Stamper;
+
+use Symfony\Component\Messenger\Envelope;
+
+/**
+ * Classes used by EnvelopeStamperMiddleware that can add stamps to envelope.
+ *
+ * @author Ryan Weaver <ryan@symfonycasts.com>
+ */
+interface EnvelopeStamperInterface
+{
+    /**
+     * Apply new stamps and return the new envelope.
+     */
+    public function stampEnvelope(Envelope $envelope): Envelope;
+}
diff --git a/src/Symfony/Component/Messenger/Tests/Middleware/EnvelopeStamperMiddlewareTest.php b/src/Symfony/Component/Messenger/Tests/Middleware/EnvelopeStamperMiddlewareTest.php
@@ -0,0 +1,46 @@
+<?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\Tests\Middleware;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Messenger\Envelope;
+use Symfony\Component\Messenger\MessageBus;
+use Symfony\Component\Messenger\Middleware\EnvelopeStamperMiddleware;
+use Symfony\Component\Messenger\Middleware\Stamper\EnvelopeStamperInterface;
+
+class EnvelopeStamperMiddlewareTest extends TestCase
+{
+    public function testHandleCallsStampers()
+    {
+        $stamper1 = $this->createMock(EnvelopeStamperInterface::class);
+        $stamper2 = $this->createMock(EnvelopeStamperInterface::class);
+
+        $envelopeOriginal = new Envelope(new \stdClass());
+        $envelopeAfterStamper1 = new Envelope(new \stdClass());
+        $envelopeAfterStamper2 = new Envelope(new \stdClass());
+
+        $stamper1->expects($this->once())
+            ->method('stampEnvelope')
+            ->with($envelopeOriginal)
+            ->willReturn($envelopeAfterStamper1);
+
+        $stamper2->expects($this->once())
+            ->method('stampEnvelope')
+            ->with($envelopeAfterStamper1)
+            ->willReturn($envelopeAfterStamper2);
+
+        $stamperMiddleware = new EnvelopeStamperMiddleware([$stamper1, $stamper2]);
+        $bus = new MessageBus([$stamperMiddleware]);
+        $actualFinalEnvelope = $bus->dispatch($envelopeOriginal);
+        $this->assertSame($envelopeAfterStamper2, $actualFinalEnvelope);
+    }
+}
-Original file line number
+Diff line change
@@ -0,0 +1,27 @@
+    <?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\Stamper;
+    use Symfony\Component\Messenger\Envelope;
+    /**
+     * Classes used by EnvelopeStamperMiddleware that can add stamps to envelope.
+     *
+     * @author Ryan Weaver <ryan@symfonycasts.com>
+     */
+    interface EnvelopeStamperInterface
+    {
+        /**
+         * Apply new stamps and return the new envelope.
+         */
+        public function stampEnvelope(Envelope $envelope): Envelope;
             Copy link

  
      
    
  

  
      

  
    Contributor


      

  

  
    
      

      
            OskarStark
  

      

      

      


        Mar 22, 2019


      
  •

  
    
      
        
          edited
          
        
        
      
    
    
      
  
        
      Loading


  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  
    
  


    

  


        
      
  
  
  
    

    There was a problem hiding this comment.


  

 
  
    

    Choose a reason for hiding this comment

    
      The reason will be displayed to describe this comment to others. Learn more.
    

    
      
      


  


  
    
      I would propose stamp(...) because stamp and envelope are already mentioned in the interface name
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  


          
      
  
    
    
            kunicmarko20 and SerkanYildiz reacted with thumbs up emoji
      
        
            
    All reactions
  


          
              
                👍
                  2 reactions
+    }