[Messenger] made dispatch() and handle() return void

Author: nicolas-grekas

Asynchronous/Middleware/SendMessageMiddleware.php

@@ -38,11 +38,13 @@ public function __construct(SenderLocatorInterface $senderLocator, array $messag
      *
      * {@inheritdoc}
      */
-    public function handle($envelope, callable $next)
+    public function handle($envelope, callable $next): void
     {
         if ($envelope->get(ReceivedStamp::class)) {
             // It's a received message. Do not send it back:
-            return $next($envelope);
+            $next($envelope);
+
+            return;
         }
 
         $sender = $this->senderLocator->getSenderForMessage($envelope->getMessage());
@@ -55,7 +57,7 @@ public function handle($envelope, callable $next)
             }
         }
 
-        return $next($envelope);
+        $next($envelope);
     }
 
     private function mustSendAndHandle($message): bool

CHANGELOG.md

@@ -6,6 +6,7 @@ CHANGELOG
 
  * The component is not experimental anymore
  * All the changes below are BC BREAKS
+ * `MessageBusInterface::dispatch()` and `MiddlewareInterface::handle()` now return `void`
  * The signature of `Amqp*` classes changed to take a `Connection` as a first argument and an optional
    `Serializer` as a second argument.
  * `SenderLocator` has been renamed to `ContainerSenderLocator`

DataCollector/MessengerDataCollector.php

@@ -98,14 +98,6 @@ private function collectMessage(string $busName, array $tracedMessage)
             'caller' => $tracedMessage['caller'],
         );
 
-        if (array_key_exists('result', $tracedMessage)) {
-            $result = $tracedMessage['result'];
-            $debugRepresentation['result'] = array(
-                'type' => \is_object($result) ? \get_class($result) : \gettype($result),
-                'value' => $result,
-            );
-        }
-
         if (isset($tracedMessage['exception'])) {
             $exception = $tracedMessage['exception'];
 

Handler/ChainHandler.php

@@ -39,12 +39,8 @@ public function __construct(array $handlers)
 
     public function __invoke($message)
     {
-        $results = array();
-
         foreach ($this->handlers as $handler) {
-            $results[] = $handler($message);
+            $handler($message);
         }
-
-        return $results;
     }
 }

MessageBus.php

@@ -38,13 +38,13 @@ public function __construct(iterable $middlewareHandlers = array())
     /**
      * {@inheritdoc}
      */
-    public function dispatch($message)
+    public function dispatch($message): void
     {
         if (!\is_object($message)) {
             throw new InvalidArgumentException(sprintf('Invalid type for message argument. Expected object, but got "%s".', \gettype($message)));
         }
 
-        return \call_user_func($this->callableForNextMiddleware(0, Envelope::wrap($message)), $message);
+        \call_user_func($this->callableForNextMiddleware(0, Envelope::wrap($message)), $message);
     }
 
     private function callableForNextMiddleware(int $index, Envelope $currentEnvelope): callable
@@ -71,7 +71,7 @@ private function callableForNextMiddleware(int $index, Envelope $currentEnvelope
                 $message = $message->getMessage();
             }
 
-            return $middleware->handle($message, $this->callableForNextMiddleware($index + 1, $currentEnvelope));
+            $middleware->handle($message, $this->callableForNextMiddleware($index + 1, $currentEnvelope));
         };
     }
 }

MessageBusInterface.php

@@ -19,11 +19,7 @@ interface MessageBusInterface
     /**
      * Dispatches the given message.
      *
-     * The bus can return a value coming from handlers, but is not required to do so.
-     *
      * @param object|Envelope $message The message or the message pre-wrapped in an envelope
-     *
-     * @return mixed
      */
-    public function dispatch($message);
+    public function dispatch($message): void;
 }

Middleware/AllowNoHandlerMiddleware.php

@@ -18,10 +18,10 @@
  */
 class AllowNoHandlerMiddleware implements MiddlewareInterface
 {
-    public function handle($message, callable $next)
+    public function handle($message, callable $next): void
     {
         try {
-            return $next($message);
+            $next($message);
         } catch (NoHandlerForMessageException $e) {
             // We allow not having a handler for this message.
         }

Middleware/Enhancers/ActivationMiddlewareDecorator.php

@@ -37,12 +37,12 @@ public function __construct(MiddlewareInterface $inner, $activated)
     /**
      * @param Envelope $envelope
      */
-    public function handle($envelope, callable $next)
+    public function handle($envelope, callable $next): void
     {
         if (\is_callable($this->activated) ? ($this->activated)($envelope) : $this->activated) {
-            return $this->inner->handle($envelope->getMessageFor($this->inner), $next);
+            $this->inner->handle($envelope->getMessageFor($this->inner), $next);
+        } else {
+            $next($envelope);
         }
-
-        return $next($envelope);
     }
 }

Middleware/Enhancers/TraceableMiddleware.php

@@ -39,7 +39,7 @@ public function __construct(MiddlewareInterface $inner, Stopwatch $stopwatch, st
     /**
      * @param Envelope $envelope
      */
-    public function handle($envelope, callable $next)
+    public function handle($envelope, callable $next): void
     {
         $class = \get_class($this->inner);
         $eventName = 'c' === $class[0] && 0 === strpos($class, "class@anonymous\0") ? get_parent_class($class).'@anonymous' : $class;
@@ -51,19 +51,15 @@ public function handle($envelope, callable $next)
         $this->stopwatch->start($eventName, $this->eventCategory);
 
         try {
-            $result = $this->inner->handle($envelope->getMessageFor($this->inner), function ($message) use ($next, $eventName) {
+            $this->inner->handle($envelope->getMessageFor($this->inner), function ($message) use ($next, $eventName) {
                 $this->stopwatch->stop($eventName);
-                $result = $next($message);
+                $next($message);
                 $this->stopwatch->start($eventName, $this->eventCategory);
-
-                return $result;
             });
         } finally {
             if ($this->stopwatch->isStarted($eventName)) {
                 $this->stopwatch->stop($eventName);
             }
         }
-
-        return $result;
     }
 }

Middleware/HandleMessageMiddleware.php

@@ -28,13 +28,11 @@ public function __construct(HandlerLocatorInterface $messageHandlerResolver)
     /**
      * {@inheritdoc}
      */
-    public function handle($message, callable $next)
+    public function handle($message, callable $next): void
     {
         $handler = $this->messageHandlerResolver->resolve($message);
-        $result = $handler($message);
+        $handler($message);
 
         $next($message);
-
-        return $result;
     }
 }