feat(notifier): add SentMessage additional info

Author: mRoca

CHANGELOG.md

@@ -5,6 +5,7 @@ CHANGELOG
 ---
 
  * Add `Dsn::getBooleanOption()`
+ * Add `info` property in `SentMessage`
 
 7.2
 ---

Message/SentMessage.php

@@ -18,9 +18,13 @@ class SentMessage
 {
     private ?string $messageId = null;
 
+    /**
+     * @param array $info attaches any Transport-related information to the sent message
+     */
     public function __construct(
         private MessageInterface $original,
         private string $transport,
+        private array $info = [],
     ) {
     }
 
@@ -43,4 +47,18 @@ public function getMessageId(): ?string
     {
         return $this->messageId;
     }
+
+    /**
+     * Returns extra info attached to the message.
+     *
+     * @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;
+    }
 }

Tests/Message/SentMessageTest.php

@@ -0,0 +1,34 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * 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;
+
+class SentMessageTest extends TestCase
+{
+    public function test()
+    {
+        $originalMessage = new DummyMessage();
+
+        $sentMessage = new SentMessage($originalMessage, 'any', ['foo' => 'bar']);
+        $sentMessage->setMessageId('the_id');
+
+        $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'));
+    }
+}