feat(notifier): add SentMessage additional info

mRoca · mRoca · commit ffdf909a7124 · 2025-01-11T19:53:52.000+01:00
diff --git a/src/Symfony/Component/Notifier/CHANGELOG.md b/src/Symfony/Component/Notifier/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+7.3
+---
+
+ * Add `SentMessage` additional info array
+
 7.2
 ---
 
diff --git a/src/Symfony/Component/Notifier/Message/SentMessage.php b/src/Symfony/Component/Notifier/Message/SentMessage.php
@@ -11,12 +11,15 @@
 
 namespace Symfony\Component\Notifier\Message;
 
+use Symfony\Contracts\HttpClient\ResponseInterface;
+
 /**
  * @author Jérémy Romey <jeremy@free-agent.fr>
  */
 class SentMessage
 {
     private ?string $messageId = null;
+    private array $info = [];
 
     public function __construct(
         private MessageInterface $original,
@@ -43,4 +46,45 @@ public function getMessageId(): ?string
     {
         return $this->messageId;
     }
+
+    /**
+     * Returns any arbitrary data attached to the message. If an HTTP response has been set by the Transport,
+     * it should be available in 'http_response' key.
+     *
+     * @param string|null $key if null, the whole info array will be returned, else returns the info value or null
+     */
+    public function getInfo(?string $key = null): mixed
+    {
+        if (null !== $key) {
+            return $this->info[$key] ?? null;
+        }
+
+        return $this->info;
+    }
+
+    /**
+     * Attaches an arbitrary info to the message.
+     * This can be used in order to set any HTTP response body if the Transport uses an HttpClient, for instance.
+     *
+     * @return $this
+     */
+    public function setInfo(string $key, mixed $value): static
+    {
+        if (null === $value) {
+            unset($this->info[$key]);
+        } else {
+            $this->info[$key] = $value;
+        }
+
+        return $this;
+    }
+
+    /**
+     * As many of the Transports are using HTTP requests,
+     * this shortcut attaches an HTTP response to the message in a standardised way.
+     */
+    public function setHttpResponseInfo(ResponseInterface $response): void
+    {
+        $this->setInfo('http_response', $response->getInfo() + ['body' => $response->toArray(false)]);
+    }
 }
diff --git a/src/Symfony/Component/Notifier/Tests/Message/SentMessageTest.php b/src/Symfony/Component/Notifier/Tests/Message/SentMessageTest.php
@@ -0,0 +1,55 @@
+<?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\Notifier\Tests\Message;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Notifier\Message\SentMessage;
+use Symfony\Component\Notifier\Tests\Transport\DummyMessage;
+use Symfony\Contracts\HttpClient\ResponseInterface;
+
+class SentMessageTest extends TestCase
+{
+    public function test()
+    {
+        $originalMessage = new DummyMessage();
+
+        $sentMessage = new SentMessage($originalMessage, 'any');
+        $sentMessage->setMessageId('the_id');
+        $sentMessage->setInfo('foo', 'bar');
+
+        $this->assertSame($originalMessage, $sentMessage->getOriginalMessage());
+        $this->assertSame('any', $sentMessage->getTransport());
+        $this->assertSame('the_id', $sentMessage->getMessageId());
+        $this->assertSame(['foo' => 'bar'], $sentMessage->getInfo());
+        $this->assertSame('bar', $sentMessage->getInfo('foo'));
+        $this->assertNull($sentMessage->getInfo('not_existing'));
+    }
+
+    public function testSetHttpResponseInfo()
+    {
+        $httpResponse = $this->createMock(ResponseInterface::class);
+        $httpResponse->method('getInfo')->willReturn(['http_code' => 200, 'http_method' => 'POST']);
+        $httpResponse->method('toArray')->willReturn(['foo' => 'bar']);
+
+        $sentMessage = new SentMessage(new DummyMessage(), 'any');
+        $sentMessage->setHttpResponseInfo($httpResponse);
+
+        $httpResponseInfo = $sentMessage->getInfo('http_response');
+        $this->assertIsArray($httpResponseInfo);
+
+        $this->assertArrayHasKey('http_method', $httpResponseInfo);
+        $this->assertEquals('POST', $httpResponseInfo['http_method']);
+
+        $this->assertArrayHasKey('body', $httpResponseInfo);
+        $this->assertEquals(['foo' => 'bar'], $httpResponseInfo['body']);
+    }
+}
