Using ResetInterface

Nyholm · Nyholm · commit 55b9fff59c4f · 2018-07-23T11:49:05.000-07:00
diff --git a/src/Symfony/Component/Messenger/Exception/MessageHandlingException.php b/src/Symfony/Component/Messenger/Exception/MessageHandlingException.php
@@ -12,19 +12,19 @@
 namespace Symfony\Component\Messenger\Exception;
 
 /**
- * When handling recorded messaged one or more handlers caused an exception.
- * This exception contains all those handler exceptions.
+ * When handling messages, sore handlers caused an exception. This exception
+ * contains all those handler exceptions.
  *
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  */
-class MessageRecorderHandlerException extends \RuntimeException implements ExceptionInterface
+class MessageHandlingException extends \RuntimeException implements ExceptionInterface
 {
     private $exceptions = array();
 
     public function __construct(array $exceptions)
     {
         $message = sprintf(
-            "One or more handlers for recorded messages threw an exception. Their messages were: \n\n%s",
+            "Some handlers for recorded messages threw an exception. Their messages were: \n\n%s",
             implode(", \n", array_map(function (\Throwable $e) {
                 return $e->getMessage();
             }, $exceptions))
diff --git a/src/Symfony/Component/Messenger/MessageRecorderInterface.php b/src/Symfony/Component/Messenger/MessageRecorderInterface.php
@@ -11,11 +11,13 @@
 
 namespace Symfony\Component\Messenger;
 
+use Symfony\Contracts\Service\ResetInterface;
+
 /**
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  * @author Matthias Noback <matthiasnoback@gmail.com>
  */
-interface MessageRecorderInterface
+interface MessageRecorderInterface extends ResetInterface
 {
     /**
      * Fetch recorded messages.
@@ -24,11 +26,6 @@ interface MessageRecorderInterface
      */
     public function fetch(): array;
 
-    /**
-     * Erase messages that were recorded since the last call to eraseMessages().
-     */
-    public function reset();
-
     /**
      * Record a message.
      *
diff --git a/src/Symfony/Component/Messenger/Middleware/HandlesRecordedMessagesMiddleware.php b/src/Symfony/Component/Messenger/Middleware/HandlesRecordedMessagesMiddleware.php
@@ -11,7 +11,7 @@
 
 namespace Symfony\Component\Messenger\Middleware;
 
-use Symfony\Component\Messenger\Exception\MessageRecorderHandlerException;
+use Symfony\Component\Messenger\Exception\MessageHandlingException;
 use Symfony\Component\Messenger\MessageBusInterface;
 use Symfony\Component\Messenger\MessageRecorderInterface;
 
@@ -35,19 +35,19 @@ public function __construct(MessageBusInterface $messageBus, MessageRecorderInte
     public function handle($message, callable $next)
     {
         // Make sure the recorder is empty before we begin
-        $this->messageRecorder->erase();
+        $this->messageRecorder->reset();
 
         try {
             $next($message);
         } catch (\Throwable $exception) {
-            $this->messageRecorder->erase();
+            $this->messageRecorder->reset();
 
             throw $exception;
         }
 
         $exceptions = array();
         while (!empty($recordedMessages = $this->messageRecorder->fetch())) {
-            $this->messageRecorder->erase();
+            $this->messageRecorder->reset();
             // Assert: The message recorder is empty, all messages are in $recordedMessages
 
             foreach ($recordedMessages as $recordedMessage) {
@@ -60,7 +60,10 @@ public function handle($message, callable $next)
         }
 
         if (!empty($exceptions)) {
-            throw MessageRecorderHandlerException::create($exceptions);
+            if (count($exceptions) === 1) {
+                throw $exceptions[0];
+            }
+            throw new MessageHandlingException($exceptions);
         }
     }
 }
diff --git a/src/Symfony/Component/Messenger/composer.json b/src/Symfony/Component/Messenger/composer.json
@@ -21,6 +21,7 @@
     "require-dev": {
         "psr/log": "~1.0",
         "symfony/console": "~3.4|~4.0",
+        "symfony/contracts": "^1.0",
         "symfony/dependency-injection": "~3.4.6|~4.0",
         "symfony/http-kernel": "~3.4|~4.0",
         "symfony/process": "~3.4|~4.0",

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\Messenger\Middleware;`
`13`	`13`
`14`		`-use Symfony\Component\Messenger\Exception\MessageRecorderHandlerException;`
	`14`	`+use Symfony\Component\Messenger\Exception\MessageHandlingException;`
`15`	`15`	`use Symfony\Component\Messenger\MessageBusInterface;`
`16`	`16`	`use Symfony\Component\Messenger\MessageRecorderInterface;`
`17`	`17`
`@@ -35,19 +35,19 @@ public function __construct(MessageBusInterface $messageBus, MessageRecorderInte`
`35`	`35`	`public function handle($message, callable $next)`
`36`	`36`	`{`
`37`	`37`	`// Make sure the recorder is empty before we begin`
`38`		`- $this->messageRecorder->erase();`
	`38`	`+ $this->messageRecorder->reset();`
`39`	`39`
`40`	`40`	`try {`
`41`	`41`	`$next($message);`
`42`	`42`	`} catch (\Throwable $exception) {`
`43`		`- $this->messageRecorder->erase();`
	`43`	`+ $this->messageRecorder->reset();`
`44`	`44`
`45`	`45`	`throw $exception;`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`$exceptions = array();`
`49`	`49`	`while (!empty($recordedMessages = $this->messageRecorder->fetch())) {`
`50`		`- $this->messageRecorder->erase();`
	`50`	`+ $this->messageRecorder->reset();`
`51`	`51`	`// Assert: The message recorder is empty, all messages are in $recordedMessages`
`52`	`52`
`53`	`53`	`foreach ($recordedMessages as $recordedMessage) {`
`@@ -60,7 +60,10 @@ public function handle($message, callable $next)`
`60`	`60`	`}`
`61`	`61`
`62`	`62`	`if (!empty($exceptions)) {`
`63`		`- throw MessageRecorderHandlerException::create($exceptions);`
	`63`	`+ if (count($exceptions) === 1) {`
	`64`	`+ throw $exceptions[0];`
	`65`	`+ }`
	`66`	`+ throw new MessageHandlingException($exceptions);`
`64`	`67`	`}`
`65`	`68`	`}`
`66`	`69`	`}`