feature #45418 [Messenger] Add HandlerArgumentsStamp (enumag)

fabpot · fabpot · commit 79ee32a603fa · 2022-08-14T21:17:39.000+02:00
This PR was merged into the 6.2 branch. Discussion ---------- [Messenger] Add HandlerArgumentsStamp | Q | A | ------------- | --- | Branch? | 6.2 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | Fix #31075 | License | MIT | Doc PR | symfony/symfony-docs#17174 As discussed in #31075 sometimes it's desirable for the messenger handler to receive additional argument than just the message itself. I understand the voiced concerns about passing the entire envelope but instead of that we could use the approach from this PR which doesn't add any additional arguments by default but is actually even more powerful since it gives the user full control what should be sent to the handler if desired. This is just a prototype of course. With #45377 in mind I used a readonly property from PHP 8.1 but of course such details can be easily adjusted. Let me know if such feature is wanted in Symfony. If yes then I'll add tests and a doc PR. Commits ------- d081267 Add HandlerArgumentsStamp
diff --git a/src/Symfony/Component/Messenger/Middleware/HandleMessageMiddleware.php b/src/Symfony/Component/Messenger/Middleware/HandleMessageMiddleware.php
@@ -23,6 +23,7 @@
 use Symfony\Component\Messenger\Stamp\AckStamp;
 use Symfony\Component\Messenger\Stamp\FlushBatchHandlersStamp;
 use Symfony\Component\Messenger\Stamp\HandledStamp;
+use Symfony\Component\Messenger\Stamp\HandlerArgumentsStamp;
 use Symfony\Component\Messenger\Stamp\NoAutoAckStamp;
 
 /**
@@ -78,7 +79,7 @@ public function handle(Envelope $envelope, StackInterface $stack): Envelope
                         $ackStamp->ack($envelope, $e);
                     });
 
-                    $result = $handler($message, $ack);
+                    $result = $this->callHandler($handler, $message, $ack, $envelope->last(HandlerArgumentsStamp::class));
 
                     if (!\is_int($result) || 0 > $result) {
                         throw new LogicException(sprintf('A handler implementing BatchHandlerInterface must return the size of the current batch as a positive integer, "%s" returned from "%s".', \is_int($result) ? $result : get_debug_type($result), get_debug_type($batchHandler)));
@@ -92,7 +93,7 @@ public function handle(Envelope $envelope, StackInterface $stack): Envelope
                         $result = $ack->getResult();
                     }
                 } else {
-                    $result = $handler($message);
+                    $result = $this->callHandler($handler, $message, null, $envelope->last(HandlerArgumentsStamp::class));
                 }
 
                 $handledStamp = HandledStamp::fromDescriptor($handlerDescriptor, $result);
@@ -142,4 +143,17 @@ private function messageHasAlreadyBeenHandled(Envelope $envelope, HandlerDescrip
 
         return false;
     }
+
+    private function callHandler(callable $handler, object $message, ?Acknowledger $ack, ?HandlerArgumentsStamp $handlerArgumentsStamp): mixed
+    {
+        $arguments = [$message];
+        if (null !== $ack) {
+            $arguments[] = $ack;
+        }
+        if (null !== $handlerArgumentsStamp) {
+            $arguments = [...$arguments, ...$handlerArgumentsStamp->getAdditionalArguments()];
+        }
+
+        return $handler(...$arguments);
+    }
 }
diff --git a/src/Symfony/Component/Messenger/Stamp/HandlerArgumentsStamp.php b/src/Symfony/Component/Messenger/Stamp/HandlerArgumentsStamp.php
@@ -0,0 +1,28 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Messenger\Stamp;
+
+/**
+ * @author Jáchym Toušek <enumag@gmail.com>
+ */
+final class HandlerArgumentsStamp implements NonSendableStampInterface
+{
+    public function __construct(
+        private array $additionalArguments,
+    ) {
+    }
+
+    public function getAdditionalArguments()
+    {
+        return $this->additionalArguments;
+    }
+}
diff --git a/src/Symfony/Component/Messenger/Tests/Middleware/HandleMessageMiddlewareTest.php b/src/Symfony/Component/Messenger/Tests/Middleware/HandleMessageMiddlewareTest.php
@@ -24,6 +24,7 @@
 use Symfony\Component\Messenger\Middleware\StackMiddleware;
 use Symfony\Component\Messenger\Stamp\AckStamp;
 use Symfony\Component\Messenger\Stamp\HandledStamp;
+use Symfony\Component\Messenger\Stamp\HandlerArgumentsStamp;
 use Symfony\Component\Messenger\Stamp\NoAutoAckStamp;
 use Symfony\Component\Messenger\Test\Middleware\MiddlewareTestCase;
 use Symfony\Component\Messenger\Tests\Fixtures\DummyMessage;
@@ -261,6 +262,40 @@ private function process(array $jobs): void
 
         $this->assertSame([$message], $handler->processedMessages);
     }
+
+    public function testHandlerArgumentsStamp()
+    {
+        $message = new DummyMessage('Hey');
+        $envelope = new Envelope($message);
+        $envelope = $envelope->with(new HandlerArgumentsStamp(['additional argument']));
+
+        $handler = $this->createPartialMock(HandleMessageMiddlewareTestCallable::class, ['__invoke']);
+
+        $middleware = new HandleMessageMiddleware(new HandlersLocator([
+            DummyMessage::class => [$handler],
+        ]));
+
+        $handler->expects($this->once())->method('__invoke')->with($message, 'additional argument');
+
+        $middleware->handle($envelope, $this->getStackMock());
+    }
+
+    public function testHandlerArgumentsStampNamedArgument()
+    {
+        $message = new DummyMessage('Hey');
+        $envelope = new Envelope($message);
+        $envelope = $envelope->with(new HandlerArgumentsStamp(['namedArgument' => 'additional named argument']));
+
+        $handler = $this->createPartialMock(HandleMessageMiddlewareNamedArgumentTestCallable::class, ['__invoke']);
+
+        $middleware = new HandleMessageMiddleware(new HandlersLocator([
+            DummyMessage::class => [$handler],
+        ]));
+
+        $handler->expects($this->once())->method('__invoke')->with($message, 'additional named argument');
+
+        $middleware->handle($envelope, $this->getStackMock());
+    }
 }
 
 class HandleMessageMiddlewareTestCallable
@@ -269,3 +304,10 @@ public function __invoke()
     {
     }
 }
+
+class HandleMessageMiddlewareNamedArgumentTestCallable
+{
+    public function __invoke(object $message, $namedArgument)
+    {
+    }
+}
