minor symfony#52915 [Messenger] Fix missing @throws phpdoc on MiddlewareInterface, MessageBusInterface and SenderInterface (VincentLanglet)

fabpot · fabpot · commit 811cce79b94d · 2023-12-08T14:57:36.000+01:00
This PR was submitted for the 5.4 branch but it was squashed and merged into the 7.1 branch instead. Discussion ---------- [Messenger] Fix missing ``@throws`` phpdoc on MiddlewareInterface, MessageBusInterface and SenderInterface | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes (kinda, it's missing phpdoc) | New feature? | no | Deprecations? | no | Issues | Fix #...  | License | MIT ``@throws`` phpdoc help the developper to know those methods can throw an exception and to have a contract about which exception can be thrown. I recently got an exception in production because of the call `$messageBus->dispatch()` without knowing it could throw an exception. Seems like it's because it iterable on every Middleware and a lot of middleware are throwing exception. As an example: - https://github.com/symfony/symfony/blob/7.1/src/Symfony/Component/Messenger/Middleware/RejectRedeliveredMessageMiddleware.php#L38 - Almost every sender are throwing `TransportException` in case of errors, which happen in the SendMessageMiddleware. Commits ------- 70a74b7 [Messenger] Fix missing ``@throws`` phpdoc on MiddlewareInterface, MessageBusInterface and SenderInterface
diff --git a/src/Symfony/Component/Messenger/MessageBusInterface.php b/src/Symfony/Component/Messenger/MessageBusInterface.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Messenger;
 
+use Symfony\Component\Messenger\Exception\ExceptionInterface;
 use Symfony\Component\Messenger\Stamp\StampInterface;
 
 /**
@@ -23,6 +24,8 @@ interface MessageBusInterface
      *
      * @param object|Envelope  $message The message or the message pre-wrapped in an envelope
      * @param StampInterface[] $stamps
+     *
+     * @throws ExceptionInterface
      */
     public function dispatch(object $message, array $stamps = []): Envelope;
 }
diff --git a/src/Symfony/Component/Messenger/Middleware/MiddlewareInterface.php b/src/Symfony/Component/Messenger/Middleware/MiddlewareInterface.php
@@ -12,11 +12,15 @@
 namespace Symfony\Component\Messenger\Middleware;
 
 use Symfony\Component\Messenger\Envelope;
+use Symfony\Component\Messenger\Exception\ExceptionInterface;
 
 /**
  * @author Samuel Roze <samuel.roze@gmail.com>
  */
 interface MiddlewareInterface
 {
+    /**
+     * @throws ExceptionInterface
+     */
     public function handle(Envelope $envelope, StackInterface $stack): Envelope;
 }
diff --git a/src/Symfony/Component/Messenger/Transport/Sender/SenderInterface.php b/src/Symfony/Component/Messenger/Transport/Sender/SenderInterface.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\Messenger\Transport\Sender;
 
 use Symfony\Component\Messenger\Envelope;
+use Symfony\Component\Messenger\Exception\ExceptionInterface;
 
 /**
  * @author Samuel Roze <samuel.roze@gmail.com>
@@ -25,6 +26,8 @@ interface SenderInterface
      * like delivery delay.
      *
      * If applicable, the returned Envelope should contain a TransportMessageIdStamp.
+     *
+     * @throws ExceptionInterface
      */
     public function send(Envelope $envelope): Envelope;
 }

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\Messenger;`
`13`	`13`
	`14`	`+use Symfony\Component\Messenger\Exception\ExceptionInterface;`
`14`	`15`	`use Symfony\Component\Messenger\Stamp\StampInterface;`
`15`	`16`
`16`	`17`	`/**`
`@@ -23,6 +24,8 @@ interface MessageBusInterface`
`23`	`24`	`*`
`24`	`25`	`* @param object\|Envelope $message The message or the message pre-wrapped in an envelope`
`25`	`26`	`* @param StampInterface[] $stamps`
	`27`	`+ *`
	`28`	`+ * @throws ExceptionInterface`
`26`	`29`	`*/`
`27`	`30`	`public function dispatch(object $message, array $stamps = []): Envelope;`
`28`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,11 +12,15 @@`
`12`	`12`	`namespace Symfony\Component\Messenger\Middleware;`
`13`	`13`
`14`	`14`	`use Symfony\Component\Messenger\Envelope;`
	`15`	`+use Symfony\Component\Messenger\Exception\ExceptionInterface;`
`15`	`16`
`16`	`17`	`/**`
`17`	`18`	`* @author Samuel Roze <samuel.roze@gmail.com>`
`18`	`19`	`*/`
`19`	`20`	`interface MiddlewareInterface`
`20`	`21`	`{`
	`22`	`+ /**`
	`23`	`+ * @throws ExceptionInterface`
	`24`	`+ */`
`21`	`25`	`public function handle(Envelope $envelope, StackInterface $stack): Envelope;`
`22`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@`
`12`	`12`	`namespace Symfony\Component\Messenger\Transport\Sender;`
`13`	`13`
`14`	`14`	`use Symfony\Component\Messenger\Envelope;`
	`15`	`+use Symfony\Component\Messenger\Exception\ExceptionInterface;`
`15`	`16`
`16`	`17`	`/**`
`17`	`18`	`* @author Samuel Roze <samuel.roze@gmail.com>`
`@@ -25,6 +26,8 @@ interface SenderInterface`
`25`	`26`	`* like delivery delay.`
`26`	`27`	`*`
`27`	`28`	`* If applicable, the returned Envelope should contain a TransportMessageIdStamp.`
	`29`	`+ *`
	`30`	`+ * @throws ExceptionInterface`
`28`	`31`	`*/`
`29`	`32`	`public function send(Envelope $envelope): Envelope;`
`30`	`33`	`}`