Merge pull request #2930 from teohhanhui/fix/messenger-handler-failed-exception

Unwrap exception thrown in handler for Symfony Messenger 4.3

Author: teohhanhui

.circleci/config.yml

@@ -39,6 +39,13 @@ commands:
           command: |
             sudo pecl install mongodb-1.5.4
             sudo docker-php-ext-enable mongodb
+  install-pcov-php-extension:
+    steps:
+      - run:
+          name: Install pcov PHP extension
+          command: |
+            sudo pecl install pcov-1.0.6
+            sudo docker-php-ext-enable pcov
   merge-code-coverage-reports:
     parameters:
       dir:
@@ -51,14 +58,16 @@ commands:
       - run:
           name: Download phpcov
           command: |
-            if [ ! -e phpcov.phar ]; then
+            if ! command -v phpcov; then
               wget https://phar.phpunit.de/phpcov.phar
+              chmod +x phpcov.phar
+              sudo mv phpcov.phar /usr/local/bin/phpcov
             fi
       - run:
           name: Merge code coverage reports
           command: |
             mkdir -p "$(dirname -- "<< parameters.out >>")"
-            phpdbg -qrr phpcov.phar merge --clover "<< parameters.out >>" "<< parameters.dir >>"
+            phpcov merge --clover "<< parameters.out >>" "<< parameters.dir >>"
   merge-test-reports:
     parameters:
       dir:
@@ -263,6 +272,7 @@ jobs:
     steps:
       - checkout
       - install-mongodb-php-extension
+      - install-pcov-php-extension
       - disable-xdebug-php-extension
       - disable-php-memory-limit
       - update-composer
@@ -276,7 +286,7 @@ jobs:
             mkdir -p build/logs/phpunit build/coverage
             split_tests=$(find tests -name '*Test.php' | circleci tests split --split-by=timings)
             export PARALLEL='-j10% --joblog build/logs/parallel.log --rpl {_}\ s/\\//_/g;'
-            phpunit_cmd='phpdbg -qrr vendor/bin/phpunit --coverage-php build/coverage/coverage-{_}.cov --log-junit build/logs/phpunit/{_}.xml --exclude-group mongodb,resource-hog --colors=always {}'
+            phpunit_cmd='vendor/bin/phpunit --coverage-php build/coverage/coverage-{_}.cov --log-junit build/logs/phpunit/{_}.xml --exclude-group mongodb,resource-hog --colors=always {}'
             echo "$split_tests" | parallel "$phpunit_cmd" || echo "$split_tests" | parallel --retry-failed "$phpunit_cmd"
       - restore-npm-cache
       - merge-test-reports:
@@ -310,6 +320,7 @@ jobs:
     steps:
       - checkout
       - install-mongodb-php-extension
+      - install-pcov-php-extension
       - disable-xdebug-php-extension
       - disable-php-memory-limit
       - update-composer
@@ -323,7 +334,7 @@ jobs:
             mkdir -p build/logs/behat build/coverage
             for f in $(find features -name '*.feature' -not -path 'features/main/exposed_state.feature' -not -path 'features/elasticsearch/*' -not -path 'features/mongodb/*' | circleci tests split --split-by=timings); do
               _f=$(echo "$f" | tr / _)
-              FEATURE="${_f}" phpdbg -qrr vendor/bin/behat --format=progress --out=std --format=junit --out=build/logs/behat/"${_f}" --profile=default-coverage --no-interaction "$f"
+              FEATURE="${_f}" vendor/bin/behat --format=progress --out=std --format=junit --out=build/logs/behat/"${_f}" --profile=default-coverage --no-interaction "$f"
             done
       - restore-npm-cache
       - merge-test-reports:
@@ -355,6 +366,7 @@ jobs:
     steps:
       - checkout
       - install-mongodb-php-extension
+      - install-pcov-php-extension
       - disable-xdebug-php-extension
       - disable-php-memory-limit
       - update-composer
@@ -367,7 +379,7 @@ jobs:
           name: Run PHPUnit tests
           command: |
             mkdir -p build/logs/phpunit
-            phpdbg -qrr vendor/bin/phpunit --coverage-clover build/logs/clover.xml --log-junit build/logs/phpunit/junit.xml --exclude-group resource-hog --colors=always --configuration phpunit_mongodb.xml
+            vendor/bin/phpunit --coverage-clover build/logs/clover.xml --log-junit build/logs/phpunit/junit.xml --exclude-group resource-hog --colors=always --configuration phpunit_mongodb.xml
       - store_test_results:
           path: build/logs
       - store_artifacts:
@@ -392,6 +404,7 @@ jobs:
     steps:
       - checkout
       - install-mongodb-php-extension
+      - install-pcov-php-extension
       - disable-xdebug-php-extension
       - disable-php-memory-limit
       - update-composer
@@ -404,7 +417,7 @@ jobs:
           name: Run Behat tests
           command: |
             mkdir -p build/logs/behat
-            phpdbg -qrr vendor/bin/behat --format=progress --out=std --format=junit --out=build/logs/behat --profile=mongodb-coverage --no-interaction
+            vendor/bin/behat --format=progress --out=std --format=junit --out=build/logs/behat --profile=mongodb-coverage --no-interaction
       - restore-npm-cache
       - merge-test-reports:
           dir: build/logs/behat
@@ -435,6 +448,7 @@ jobs:
     steps:
       - checkout
       - install-mongodb-php-extension
+      - install-pcov-php-extension
       - disable-xdebug-php-extension
       - disable-php-memory-limit
       - update-composer
@@ -447,7 +461,7 @@ jobs:
           name: Run Behat tests
           command: |
             mkdir -p build/logs/behat
-            phpdbg -qrr vendor/bin/behat --format=progress --out=std --format=junit --out=build/logs/behat --profile=elasticsearch-coverage --no-interaction
+            vendor/bin/behat --format=progress --out=std --format=junit --out=build/logs/behat --profile=elasticsearch-coverage --no-interaction
       - restore-npm-cache
       - merge-test-reports:
           dir: build/logs/behat

.gitignore

@@ -1,5 +1,6 @@
 /.php_cs
 /.php_cs.cache
+/.phpunit.result.cache
 /build/
 /composer.lock
 /composer.phar

composer.json

@@ -53,7 +53,7 @@
         "phpstan/phpstan-doctrine": "^0.11",
         "phpstan/phpstan-phpunit": "^0.11",
         "phpstan/phpstan-symfony": "^0.11",
-        "phpunit/phpunit": "^7.5.2",
+        "phpunit/phpunit": "^7.5.2 || ^8.0",
         "psr/log": "^1.0",
         "ramsey/uuid": "^3.7",
         "ramsey/uuid-doctrine": "^1.4",

features/json/input_output.feature

@@ -7,7 +7,7 @@ Feature: JSON DTO input and output
     Given I add "Accept" header equal to "application/json"
     And I add "Content-Type" header equal to "application/json"
 
-  Scenario: Messenger handler returning output object
+  Scenario: Request a password reset
     And I send a "POST" request to "/users/password_reset_request" with body:
     """
     {
@@ -23,3 +23,15 @@ Feature: JSON DTO input and output
       "emailSentAt": "2019-07-05T15:44:00+00:00"
     }
     """
+
+  Scenario: Request a password reset for a non-existent user
+    And I send a "POST" request to "/users/password_reset_request" with body:
+    """
+    {
+      "email": "[email protected]"
+    }
+    """
+    Then the response status code should be 404
+    And the response should be in JSON
+    And the header "Content-Type" should be equal to "application/problem+json; charset=utf-8"
+    And the JSON node "detail" should be equal to "User does not exist."

src/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php

@@ -44,7 +44,7 @@
 use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
 use Symfony\Component\Finder\Finder;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
-use Symfony\Component\Messenger\Exception\UnrecoverableMessageHandlingException;
+use Symfony\Component\Messenger\Exception\HandlerFailedException;
 use Symfony\Component\Messenger\MessageBusInterface;
 use Symfony\Component\Validator\Validator\ValidatorInterface;
 use Symfony\Component\Yaml\Yaml;
@@ -526,7 +526,7 @@ private function registerMercureConfiguration(ContainerBuilder $container, array
             $loader->load('doctrine_orm_mercure_publisher.xml');
 
             // BC for Symfony Messenger 4.2
-            if (interface_exists(MessageBusInterface::class) && !class_exists(UnrecoverableMessageHandlingException::class)) {
+            if (interface_exists(MessageBusInterface::class) && !class_exists(HandlerFailedException::class)) {
                 $container->getDefinition('api_platform.doctrine.listener.mercure.publish')->replaceArgument(5, new Reference('message_bus', ContainerInterface::IGNORE_ON_INVALID_REFERENCE));
             }
         }
@@ -541,7 +541,7 @@ private function registerMessengerConfiguration(ContainerBuilder $container, arr
         $loader->load('messenger.xml');
 
         // BC for Symfony Messenger 4.2
-        if (interface_exists(MessageBusInterface::class) && !class_exists(UnrecoverableMessageHandlingException::class)) {
+        if (interface_exists(MessageBusInterface::class) && !class_exists(HandlerFailedException::class)) {
             $container->setAlias('api_platform.message_bus', 'message_bus');
         }
     }

src/EventListener/ExceptionListener.php

@@ -17,6 +17,7 @@
 use Psr\Log\LoggerInterface;
 use Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent;
 use Symfony\Component\HttpKernel\EventListener\ExceptionListener as BaseExceptionListener;
+use Symfony\Component\Messenger\Exception\HandlerFailedException;
 
 /**
  * Handles requests errors.
@@ -44,6 +45,18 @@ public function onKernelException(GetResponseForExceptionEvent $event): void
             return;
         }
 
+        // unwrap the exception thrown in handler for Symfony Messenger >= 4.3
+        $exception = $event->getException();
+        if ($exception instanceof HandlerFailedException) {
+            /** @var \Throwable $previousException */
+            $previousException = $exception->getPrevious();
+            if (!$previousException instanceof \Exception) {
+                throw $previousException;
+            }
+
+            $event->setException($previousException);
+        }
+
         $this->exceptionListener->onKernelException($event);
     }
 }

src/Test/DoctrineMongoDbOdmFilterTestCase.php

@@ -21,6 +21,8 @@
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
 
 /**
+ * @internal
+ *
  * @author Alan Poulain <[email protected]>
  */
 abstract class DoctrineMongoDbOdmFilterTestCase extends KernelTestCase
@@ -45,7 +47,7 @@ abstract class DoctrineMongoDbOdmFilterTestCase extends KernelTestCase
      */
     protected $filterClass;
 
-    protected function setUp()
+    protected function setUp(): void
     {
         self::bootKernel();
 

src/Test/DoctrineMongoDbOdmSetup.php

@@ -22,6 +22,8 @@
 /**
  * Convenience class for setting up Doctrine from different installations and configurations.
  *
+ * @internal
+ *
  * @author Benjamin Eberlei <[email protected]>
  * @author Alan Poulain <[email protected]>
  */

src/Test/DoctrineOrmFilterTestCase.php

@@ -24,6 +24,8 @@
 use Symfony\Component\HttpFoundation\RequestStack;
 
 /**
+ * @internal
+ *
  * @author Kévin Dunglas <[email protected]>
  */
 abstract class DoctrineOrmFilterTestCase extends KernelTestCase
@@ -53,7 +55,7 @@ abstract class DoctrineOrmFilterTestCase extends KernelTestCase
      */
     protected $filterClass;
 
-    protected function setUp()
+    protected function setUp(): void
     {
         self::bootKernel();
 

tests/Bridge/Doctrine/MongoDbOdm/Extension/PaginationExtensionTest.php

@@ -43,7 +43,7 @@ class PaginationExtensionTest extends TestCase
 {
     private $managerRegistryProphecy;
 
-    protected function setUp()
+    protected function setUp(): void
     {
         parent::setUp();