PBC-1677: Adjust ValidationMiddlewarePlugin to only throw exceptions …

…on received messages (#10217) PBC-1677 Fixed MessageBroker ValidationMiddlewarePlugin to only throw exceptions on received messages
spryker · Jun 9, 2023 · d444f24 · d444f24
1 parent 9a64abc
commit d444f24
Show file tree

Hide file tree

Showing 5 changed files with 225 additions and 1 deletion.
diff --git a/...ryker/Zed/MessageBroker/Communication/Plugin/MessageBroker/ValidationMiddlewarePlugin.php b/...ryker/Zed/MessageBroker/Communication/Plugin/MessageBroker/ValidationMiddlewarePlugin.php
@@ -7,18 +7,23 @@
 
 namespace Spryker\Zed\MessageBroker\Communication\Plugin\MessageBroker;
 
+use Spryker\Shared\Log\LoggerTrait;
 use Spryker\Zed\Kernel\Communication\AbstractPlugin;
+use Spryker\Zed\MessageBrokerExtension\Dependency\Plugin\MessageValidatorPluginInterface;
 use Spryker\Zed\MessageBrokerExtension\Dependency\Plugin\MiddlewarePluginInterface;
 use Symfony\Component\Messenger\Envelope;
 use Symfony\Component\Messenger\Exception\UnrecoverableMessageHandlingException;
 use Symfony\Component\Messenger\Middleware\StackInterface;
+use Symfony\Component\Messenger\Stamp\ReceivedStamp;
 
 /**
  * @method \Spryker\Zed\MessageBroker\MessageBrokerConfig getConfig()
  * @method \Spryker\Zed\MessageBroker\Business\MessageBrokerFacadeInterface getFacade()
  */
 class ValidationMiddlewarePlugin extends AbstractPlugin implements MiddlewarePluginInterface
 {
+    use LoggerTrait;
+
     /**
      * {@inheritDoc}
      *
@@ -36,7 +41,13 @@ public function handle(Envelope $envelope, StackInterface $stack): Envelope
         /** @var \Spryker\Shared\Kernel\Transfer\TransferInterface $messageTransfer */
         $messageTransfer = $envelope->getMessage();
         if (!$this->getFacade()->canHandleMessage($messageTransfer)) {
-            throw new UnrecoverableMessageHandlingException();
+            if ($envelope->all(ReceivedStamp::class)) {
+                throw new UnrecoverableMessageHandlingException();
+            }
+
+            $this->getLogger()->error(sprintf('Message "%s" can not be handled. At least one of the "%s"s attached to the "%s" marked the message as invalid.', get_class($messageTransfer), MessageValidatorPluginInterface::class, static::class));
+
+            return $envelope;
         }
 
         return $stack->next()->handle($envelope, $stack);

diff --git a/...t/Zed/MessageBroker/Communication/Plugin/MessageBroker/ValidationMiddlewarePluginTest.php b/...t/Zed/MessageBroker/Communication/Plugin/MessageBroker/ValidationMiddlewarePluginTest.php
@@ -0,0 +1,112 @@
+<?php
+
+/**
+ * Copyright © 2016-present Spryker Systems GmbH. All rights reserved.
+ * Use of this software requires acceptance of the Evaluation License Agreement. See LICENSE file.
+ */
+
+namespace SprykerTest\Zed\MessageBroker\Communication\Plugin\MessageBroker;
+
+use Codeception\Test\Unit;
+use SprykerTest\Zed\MessageBroker\MessageBrokerCommunicationTester;
+use Symfony\Component\Messenger\Exception\UnrecoverableMessageHandlingException;
+use Symfony\Component\Messenger\Stamp\ReceivedStamp;
+
+/**
+ * Auto-generated group annotations
+ *
+ * @group SprykerTest
+ * @group Zed
+ * @group MessageBroker
+ * @group Communication
+ * @group Plugin
+ * @group MessageBroker
+ * @group ValidationMiddlewarePluginTest
+ * Add your own group annotations below this line
+ */
+class ValidationMiddlewarePluginTest extends Unit
+{
+    /**
+     * @var \SprykerTest\Zed\MessageBroker\MessageBrokerCommunicationTester
+     */
+    protected MessageBrokerCommunicationTester $tester;
+
+    /**
+     * @return void
+     */
+    public function testValidationMiddlewarePluginCantHandleReceivedMessageWillThrowException(): void
+    {
+        // Arrange
+        $envelope = $this->tester->haveEnvelopeWithReceivedStamp();
+
+        $validationMiddlewarePlugin = $this->tester->createValidationMiddlewarePluginThatCanNotHandleAMessage();
+
+        $stackMock = $this->tester->createStackMockWithNeverCalledNextMethod();
+
+        // Expectation
+        $this->expectException(UnrecoverableMessageHandlingException::class);
+
+        // Act
+        $validationMiddlewarePlugin->handle($envelope, $stackMock);
+    }
+
+    /**
+     * @return void
+     */
+    public function testValidationMiddlewarePluginCantHandleSentMessageWillReturnUnhandledEnvelope(): void
+    {
+        // Arrange
+        $envelope = $this->tester->haveEnvelope();
+
+        $validationMiddlewarePlugin = $this->tester->createValidationMiddlewarePluginThatCanNotHandleAMessage();
+
+        $stackMock = $this->tester->createStackMockWithNeverCalledNextMethod();
+
+        // Act
+        $handledEnvelope = $validationMiddlewarePlugin->handle($envelope, $stackMock);
+
+        // Assert
+        $this->assertSame($envelope, $handledEnvelope);
+        $this->assertCount(0, $handledEnvelope->all());
+    }
+
+    /**
+     * @return void
+     */
+    public function testValidationMiddlewarePluginCanHandleSentMessageWillReturnEnvelope(): void
+    {
+        // Arrange
+        $envelope = $this->tester->haveEnvelope();
+
+        $validationMiddlewarePlugin = $this->tester->createValidationMiddlewarePluginThatCanHandleAMessage();
+
+        $stackMock = $this->tester->createStackMockWithOnceCalledNextMethod($envelope);
+
+        // Act
+        $handledEnvelope = $validationMiddlewarePlugin->handle($envelope, $stackMock);
+
+        // Assert
+        $this->assertSame($envelope, $handledEnvelope);
+        $this->assertCount(0, $handledEnvelope->all());
+    }
+
+    /**
+     * @return void
+     */
+    public function testValidationMiddlewarePluginCanHandleReceivedMessageWillReturnEnvelope(): void
+    {
+        // Arrange
+        $envelope = $this->tester->haveEnvelopeWithReceivedStamp();
+
+        $validationMiddlewarePlugin = $this->tester->createValidationMiddlewarePluginThatCanHandleAMessage(true);
+
+        $stackMock = $this->tester->createStackMockWithOnceCalledNextMethod($envelope);
+
+        // Act
+        $handledEnvelope = $validationMiddlewarePlugin->handle($envelope, $stackMock);
+
+        // Assert
+        $this->assertSame($envelope, $handledEnvelope);
+        $this->assertCount(1, $handledEnvelope->all(ReceivedStamp::class));
+    }
+}
diff --git a/tests/SprykerTest/Zed/MessageBroker/_support/Helper/MessageBrokerHelper.php b/tests/SprykerTest/Zed/MessageBroker/_support/Helper/MessageBrokerHelper.php
@@ -13,6 +13,7 @@
 use Generated\Shared\DataBuilder\MessageAttributesBuilder;
 use Generated\Shared\Transfer\MessageAttributesTransfer;
 use Generated\Shared\Transfer\MessageBrokerWorkerConfigTransfer;
+use Generated\Shared\Transfer\MessageTransfer;
 use Spryker\Zed\MessageBroker\Business\MessageBrokerBusinessFactory;
 use Spryker\Zed\MessageBroker\Business\MessageBrokerFacadeInterface;
 use Spryker\Zed\MessageBroker\Business\Worker\Worker;
@@ -29,6 +30,7 @@
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\Messenger\Envelope;
 use Symfony\Component\Messenger\EventListener\StopWorkerOnTimeLimitListener;
+use Symfony\Component\Messenger\Stamp\ReceivedStamp;
 use Symfony\Component\Messenger\Stamp\SentStamp;
 use Symfony\Component\Messenger\Transport\InMemoryTransport;
 use Symfony\Component\Messenger\Transport\Receiver\ReceiverInterface;
@@ -461,4 +463,24 @@ protected function getFactory(): MessageBrokerBusinessFactory
 
         return $messageBrokerFactory;
     }
+
+    /**
+     * @return \Symfony\Component\Messenger\Envelope
+     */
+    public function haveEnvelope(): Envelope
+    {
+        $messageTransfer = new MessageTransfer();
+
+        return new Envelope($messageTransfer);
+    }
+
+    /**
+     * @return \Symfony\Component\Messenger\Envelope
+     */
+    public function haveEnvelopeWithReceivedStamp(): Envelope
+    {
+        $envelope = $this->haveEnvelope();
+
+        return $envelope->with(new ReceivedStamp('someTransport'));
+    }
 }
diff --git a/tests/SprykerTest/Zed/MessageBroker/_support/MessageBrokerCommunicationTester.php b/tests/SprykerTest/Zed/MessageBroker/_support/MessageBrokerCommunicationTester.php
@@ -8,9 +8,17 @@
 namespace SprykerTest\Zed\MessageBroker;
 
 use Codeception\Actor;
+use Codeception\Stub;
+use Codeception\Stub\Expected;
+use PHPUnit\Framework\MockObject\MockObject;
+use Spryker\Zed\MessageBroker\Business\MessageBrokerFacade;
 use Spryker\Zed\MessageBroker\Communication\Plugin\Console\MessageBrokerDebugConsole;
 use Spryker\Zed\MessageBroker\Communication\Plugin\Console\MessageBrokerWorkerConsole;
+use Spryker\Zed\MessageBroker\Communication\Plugin\MessageBroker\ValidationMiddlewarePlugin;
 use Symfony\Component\Console\Tester\CommandTester;
+use Symfony\Component\Messenger\Envelope;
+use Symfony\Component\Messenger\Middleware\MiddlewareInterface;
+use Symfony\Component\Messenger\Middleware\StackInterface;
 
 /**
  * Inherited Methods
@@ -58,4 +66,74 @@ public function getDebugConsoleCommandTester(): CommandTester
 
         return $this->getConsoleTester($command);
     }
+
+    /**
+     * @return \Spryker\Zed\MessageBroker\Communication\Plugin\MessageBroker\ValidationMiddlewarePlugin
+     */
+    public function createValidationMiddlewarePluginThatCanHandleAMessage(): ValidationMiddlewarePlugin
+    {
+        $messageBrokerFacadeMock = Stub::make(MessageBrokerFacade::class, [
+            'canHandleMessage' => true,
+        ]);
+
+        $validationMiddlewarePlugin = new ValidationMiddlewarePlugin();
+        $validationMiddlewarePlugin->setFacade($messageBrokerFacadeMock);
+
+        return $validationMiddlewarePlugin;
+    }
+
+    /**
+     * @return \Spryker\Zed\MessageBroker\Communication\Plugin\MessageBroker\ValidationMiddlewarePlugin
+     */
+    public function createValidationMiddlewarePluginThatCanNotHandleAMessage(): ValidationMiddlewarePlugin
+    {
+        $messageBrokerFacadeMock = Stub::make(MessageBrokerFacade::class, [
+            'canHandleMessage' => false,
+        ]);
+
+        $validationMiddlewarePlugin = new ValidationMiddlewarePlugin();
+        $validationMiddlewarePlugin->setFacade($messageBrokerFacadeMock);
+
+        return $validationMiddlewarePlugin;
+    }
+
+    /**
+     * @param \Symfony\Component\Messenger\Envelope $envelope
+     *
+     * @return \Symfony\Component\Messenger\Middleware\MiddlewareInterface|\PHPUnit\Framework\MockObject\MockObject
+     */
+    public function createMiddlewareInterfaceMock(Envelope $envelope): MiddlewareInterface|MockObject
+    {
+        return Stub::makeEmpty(MiddlewareInterface::class, [
+            'handle' => $envelope,
+        ]);
+    }
+
+    /**
+     * @param \Symfony\Component\Messenger\Envelope $envelope
+     *
+     * @return \Symfony\Component\Messenger\Middleware\StackInterface|\PHPUnit\Framework\MockObject\MockObject
+     */
+    public function createStackMockWithOnceCalledNextMethod(Envelope $envelope): StackInterface|MockObject
+    {
+        $stackMock = Stub::makeEmpty(StackInterface::class);
+
+        $middlewareInterfaceMock = $this->createMiddlewareInterfaceMock($envelope);
+
+        $stackMock->expects(Expected::once()->getMatcher())->method('next')->willReturn($middlewareInterfaceMock);
+
+        return $stackMock;
+    }
+
+    /**
+     * @return \Symfony\Component\Messenger\Middleware\StackInterface|\PHPUnit\Framework\MockObject\MockObject
+     */
+    public function createStackMockWithNeverCalledNextMethod(): StackInterface|MockObject
+    {
+        $stackMock = Stub::makeEmpty(StackInterface::class);
+
+        $stackMock->expects(Expected::never()->getMatcher())->method('next');
+
+        return $stackMock;
+    }
 }
diff --git a/tests/SprykerTest/Zed/MessageBroker/codeception.yml b/tests/SprykerTest/Zed/MessageBroker/codeception.yml
@@ -47,3 +47,4 @@ suites:
                 - \SprykerTest\Zed\Application\Helper\ApplicationHelper
                 - \SprykerTest\Zed\EventDispatcher\Helper\EventDispatcherHelper
                 - \SprykerTest\Zed\Console\Helper\ConsoleHelper
+                - \SprykerTest\Shared\Store\Helper\StoreDependencyHelper