[Messenger] make senders/handlers locator accept envelopes

nicolas-grekas · nicolas-grekas · commit 9cd88b0dc5b4 · 2018-11-01T10:43:31.000+01:00
diff --git a/src/Symfony/Component/Messenger/Envelope.php b/src/Symfony/Component/Messenger/Envelope.php
@@ -74,9 +74,4 @@ public function getMessage()
     {
         return $this->message;
     }
-
-    public function getMessageName(): string
-    {
-        return \get_class($this->message);
-    }
 }
diff --git a/src/Symfony/Component/Messenger/Handler/HandlersLocator.php b/src/Symfony/Component/Messenger/Handler/HandlersLocator.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\Messenger\Handler;
 
+use Symfony\Component\Messenger\Envelope;
+
 /**
  * Maps a message to a list of handlers.
  *
@@ -33,11 +35,11 @@ public function __construct(array $handlers)
     /**
      * {@inheritdoc}
      */
-    public function getHandlers(string $name): iterable
+    public function getHandlers(Envelope $envelope): iterable
     {
         $seen = array();
 
-        foreach (self::listTypes($name) as $type) {
+        foreach (self::listTypes($envelope) as $type) {
             foreach ($this->handlers[$type] ?? array() as $handler) {
                 if (!\in_array($handler, $seen, true)) {
                     yield $seen[] = $handler;
@@ -49,11 +51,9 @@ public function getHandlers(string $name): iterable
     /**
      * @internal
      */
-    public static function listTypes(string $class): array
+    public static function listTypes(Envelope $envelope): array
     {
-        if (!class_exists($class, false)) {
-            return array($class => $class, '*' => '*');
-        }
+        $class = \get_class($envelope->getMessage());
 
         return array($class => $class)
             + class_parents($class)
diff --git a/src/Symfony/Component/Messenger/Handler/HandlersLocatorInterface.php b/src/Symfony/Component/Messenger/Handler/HandlersLocatorInterface.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\Messenger\Handler;
 
+use Symfony\Component\Messenger\Envelope;
+
 /**
  * Maps a message to a list of handlers.
  *
@@ -25,5 +27,5 @@ interface HandlersLocatorInterface
      *
      * @return iterable|callable[]
      */
-    public function getHandlers(string $name): iterable;
+    public function getHandlers(Envelope $envelope): iterable;
 }
diff --git a/src/Symfony/Component/Messenger/Middleware/HandleMessageMiddleware.php b/src/Symfony/Component/Messenger/Middleware/HandleMessageMiddleware.php
@@ -40,12 +40,11 @@ public function handle(Envelope $envelope, StackInterface $stack): Envelope
     {
         $handler = null;
         $message = $envelope->getMessage();
-        $name = $envelope->getMessageName();
-        foreach ($this->handlersLocator->getHandlers($name) as $handler) {
+        foreach ($this->handlersLocator->getHandlers($envelope) as $handler) {
             $handler($message);
         }
         if (null === $handler && !$this->allowNoHandlers) {
-            throw new NoHandlerForMessageException(sprintf('No handler for message "%s".', $name));
+            throw new NoHandlerForMessageException(sprintf('No handler for message "%s".', \get_class($envelope->getMessage())));
         }
 
         return $stack->next()->handle($envelope, $stack);
diff --git a/src/Symfony/Component/Messenger/Middleware/LoggingMiddleware.php b/src/Symfony/Component/Messenger/Middleware/LoggingMiddleware.php
@@ -36,20 +36,20 @@ public function handle(Envelope $envelope, StackInterface $stack): Envelope
         $message = $envelope->getMessage();
         $context = array(
             'message' => $message,
-            'name' => $envelope->getMessageName(),
+            'class' => \get_class($envelope->getMessage()),
         );
-        $this->logger->debug('Starting handling message "{name}"', $context);
+        $this->logger->debug('Starting handling message "{class}"', $context);
 
         try {
             $envelope = $stack->next()->handle($envelope, $stack);
         } catch (\Throwable $e) {
             $context['exception'] = $e;
-            $this->logger->warning('An exception occurred while handling message "{name}"', $context);
+            $this->logger->warning('An exception occurred while handling message "{class}"', $context);
 
             throw $e;
         }
 
-        $this->logger->debug('Finished handling message "{name}"', $context);
+        $this->logger->debug('Finished handling message "{class}"', $context);
 
         return $envelope;
     }
diff --git a/src/Symfony/Component/Messenger/Middleware/SendMessageMiddleware.php b/src/Symfony/Component/Messenger/Middleware/SendMessageMiddleware.php
@@ -42,7 +42,7 @@ public function handle(Envelope $envelope, StackInterface $stack): Envelope
         $handle = false;
         $sender = null;
 
-        foreach ($this->sendersLocator->getSenders($envelope->getMessageName(), $handle) as $sender) {
+        foreach ($this->sendersLocator->getSenders($envelope, $handle) as $sender) {
             $envelope = $sender->send($envelope);
         }
 
diff --git a/src/Symfony/Component/Messenger/Tests/Transport/AmqpExt/Fixtures/long_receiver.php b/src/Symfony/Component/Messenger/Tests/Transport/AmqpExt/Fixtures/long_receiver.php
@@ -32,7 +32,7 @@
 $worker = new Worker($receiver, new class() implements MessageBusInterface {
     public function dispatch($envelope): Envelope
     {
-        echo 'Get envelope with message: '.$envelope->getMessageName()."\n";
+        echo 'Get envelope with message: '.\get_class($envelope->getMessage())."\n";
         echo sprintf("with stamps: %s\n", json_encode(array_keys($envelope->all()), JSON_PRETTY_PRINT));
 
         sleep(30);
diff --git a/src/Symfony/Component/Messenger/Tests/Transport/Sender/SendersLocatorTest.php b/src/Symfony/Component/Messenger/Tests/Transport/Sender/SendersLocatorTest.php
@@ -12,11 +12,11 @@
 namespace Symfony\Component\Messenger\Tests\Transport\Sender;
 
 use PHPUnit\Framework\TestCase;
-use Symfony\Component\Messenger\Exception\RuntimeException;
+use Symfony\Component\Messenger\Envelope;
 use Symfony\Component\Messenger\Tests\Fixtures\DummyMessage;
 use Symfony\Component\Messenger\Tests\Fixtures\SecondMessage;
-use Symfony\Component\Messenger\Transport\Sender\SendersLocator;
 use Symfony\Component\Messenger\Transport\Sender\SenderInterface;
+use Symfony\Component\Messenger\Transport\Sender\SendersLocator;
 
 class SendersLocatorTest extends TestCase
 {
@@ -27,7 +27,7 @@ public function testItReturnsTheSenderBasedOnTheMessageClass()
             DummyMessage::class => array($sender),
         ));
 
-        $this->assertSame(array($sender), iterator_to_array($locator->getSenders(DummyMessage::class)));
-        $this->assertSame(array(), iterator_to_array($locator->getSenders(SecondMessage::class)));
+        $this->assertSame(array($sender), iterator_to_array($locator->getSenders(new Envelope(new DummyMessage('a')))));
+        $this->assertSame(array(), iterator_to_array($locator->getSenders(new Envelope(new SecondMessage('b')))));
     }
 }
diff --git a/src/Symfony/Component/Messenger/Transport/Sender/SendersLocator.php b/src/Symfony/Component/Messenger/Transport/Sender/SendersLocator.php
@@ -11,9 +11,8 @@
 
 namespace Symfony\Component\Messenger\Transport\Sender;
 
-use Symfony\Component\Messenger\Exception\RuntimeException;
+use Symfony\Component\Messenger\Envelope;
 use Symfony\Component\Messenger\Handler\HandlersLocator;
-use Symfony\Component\Messenger\Transport\Sender\SenderInterface;
 
 /**
  * Maps a message to a list of senders.
@@ -40,13 +39,13 @@ public function __construct(array $senders, array $sendAndHandle = array())
     /**
      * {@inheritdoc}
      */
-    public function getSenders(string $name, ?bool &$handle = false): iterable
+    public function getSenders(Envelope $envelope, ?bool &$handle = false): iterable
     {
         $handle = false;
         $sender = null;
         $seen = array();
 
-        foreach (HandlersLocator::listTypes($name) as $type) {
+        foreach (HandlersLocator::listTypes($envelope) as $type) {
             foreach ($this->senders[$type] ?? array() as $sender) {
                 if (!\in_array($sender, $seen, true)) {
                     yield $seen[] = $sender;
diff --git a/src/Symfony/Component/Messenger/Transport/Sender/SendersLocatorInterface.php b/src/Symfony/Component/Messenger/Transport/Sender/SendersLocatorInterface.php
@@ -11,7 +11,7 @@
 
 namespace Symfony\Component\Messenger\Transport\Sender;
 
-use Symfony\Component\Messenger\Transport\Sender\SenderInterface;
+use Symfony\Component\Messenger\Envelope;
 
 /**
  * Maps a message to a list of senders.
@@ -31,5 +31,5 @@ interface SendersLocatorInterface
      *
      * @return iterable|SenderInterface[]
      */
-    public function getSenders(string $name, ?bool &$handle = false): iterable;
+    public function getSenders(Envelope $envelope, ?bool &$handle = false): iterable;
 }

Original file line number	Diff line number	Diff line change
`@@ -74,9 +74,4 @@ public function getMessage()`
`74`	`74`	`{`
`75`	`75`	`return $this->message;`
`76`	`76`	`}`
`77`		`-`
`78`		`- public function getMessageName(): string`
`79`		`- {`
`80`		`- return \get_class($this->message);`
`81`		`- }`
`82`	`77`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,8 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\Messenger\Handler;`
`13`	`13`
	`14`	`+use Symfony\Component\Messenger\Envelope;`
	`15`	`+`
`14`	`16`	`/**`
`15`	`17`	`* Maps a message to a list of handlers.`
`16`	`18`	`*`
`@@ -25,5 +27,5 @@ interface HandlersLocatorInterface`
`25`	`27`	`*`
`26`	`28`	`* @return iterable\|callable[]`
`27`	`29`	`*/`
`28`		`- public function getHandlers(string $name): iterable;`
	`30`	`+ public function getHandlers(Envelope $envelope): iterable;`
`29`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -40,12 +40,11 @@ public function handle(Envelope $envelope, StackInterface $stack): Envelope`
`40`	`40`	`{`
`41`	`41`	`$handler = null;`
`42`	`42`	`$message = $envelope->getMessage();`
`43`		`- $name = $envelope->getMessageName();`
`44`		`- foreach ($this->handlersLocator->getHandlers($name) as $handler) {`
	`43`	`+ foreach ($this->handlersLocator->getHandlers($envelope) as $handler) {`
`45`	`44`	`$handler($message);`
`46`	`45`	`}`
`47`	`46`	`if (null === $handler && !$this->allowNoHandlers) {`
`48`		`- throw new NoHandlerForMessageException(sprintf('No handler for message "%s".', $name));`
	`47`	`+ throw new NoHandlerForMessageException(sprintf('No handler for message "%s".', \get_class($envelope->getMessage())));`
`49`	`48`	`}`
`50`	`49`
`51`	`50`	`return $stack->next()->handle($envelope, $stack);`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ public function handle(Envelope $envelope, StackInterface $stack): Envelope`
`42`	`42`	`$handle = false;`
`43`	`43`	`$sender = null;`
`44`	`44`
`45`		`- foreach ($this->sendersLocator->getSenders($envelope->getMessageName(), $handle) as $sender) {`
	`45`	`+ foreach ($this->sendersLocator->getSenders($envelope, $handle) as $sender) {`
`46`	`46`	`$envelope = $sender->send($envelope);`
`47`	`47`	`}`
`48`	`48`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@`
`32`	`32`	`$worker = new Worker($receiver, new class() implements MessageBusInterface {`
`33`	`33`	`public function dispatch($envelope): Envelope`
`34`	`34`	`{`
`35`		`- echo 'Get envelope with message: '.$envelope->getMessageName()."\n";`
	`35`	`+ echo 'Get envelope with message: '.\get_class($envelope->getMessage())."\n";`
`36`	`36`	`echo sprintf("with stamps: %s\n", json_encode(array_keys($envelope->all()), JSON_PRETTY_PRINT));`
`37`	`37`
`38`	`38`	`sleep(30);`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\Messenger\Transport\Sender;`
`13`	`13`
`14`		`-use Symfony\Component\Messenger\Transport\Sender\SenderInterface;`
	`14`	`+use Symfony\Component\Messenger\Envelope;`
`15`	`15`
`16`	`16`	`/**`
`17`	`17`	`* Maps a message to a list of senders.`
`@@ -31,5 +31,5 @@ interface SendersLocatorInterface`
`31`	`31`	`*`
`32`	`32`	`* @return iterable\|SenderInterface[]`
`33`	`33`	`*/`
`34`		`- public function getSenders(string $name, ?bool &$handle = false): iterable;`
	`34`	`+ public function getSenders(Envelope $envelope, ?bool &$handle = false): iterable;`
`35`	`35`	`}`