bug #48366 [Mailer] Fix body renderer check (fabpot)

fabpot · fabpot · commit 8b8e1d40d6b4 · 2022-11-28T18:56:56.000+01:00
This PR was merged into the 6.2 branch. Discussion ---------- [Mailer] Fix body renderer check | Q | A | ------------- | --- | Branch? | 6.2 | Bug fix? | yes | New feature? | no  | Deprecations? | no  | Tickets | n/a  | License | MIT | Doc PR | n/a What I did in #47049 does not work as one can have many message listeners. So, we need to do this check after all listeners are run. Commits ------- 8bb7522 [Mailer] Fix body renderer check
diff --git a/src/Symfony/Component/Mailer/EventListener/MessageListener.php b/src/Symfony/Component/Mailer/EventListener/MessageListener.php
@@ -11,11 +11,9 @@
 
 namespace Symfony\Component\Mailer\EventListener;
 
-use Symfony\Bridge\Twig\Mime\TemplatedEmail;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\Mailer\Event\MessageEvent;
 use Symfony\Component\Mailer\Exception\InvalidArgumentException;
-use Symfony\Component\Mailer\Exception\LogicException;
 use Symfony\Component\Mailer\Exception\RuntimeException;
 use Symfony\Component\Mime\BodyRendererInterface;
 use Symfony\Component\Mime\Header\Headers;
@@ -121,10 +119,6 @@ private function setHeaders(Message $message): void
     private function renderMessage(Message $message): void
     {
         if (!$this->renderer) {
-            if ($message instanceof TemplatedEmail && ($message->getTextTemplate() || $message->getHtmlTemplate())) {
-                throw new LogicException(sprintf('You must configure a "%s" when a "%s" instance has a text or HTML template set.', BodyRendererInterface::class, get_debug_type($message)));
-            }
-
             return;
         }
 
diff --git a/src/Symfony/Component/Mailer/Tests/Transport/AbstractTransportTest.php b/src/Symfony/Component/Mailer/Tests/Transport/AbstractTransportTest.php
@@ -12,11 +12,17 @@
 namespace Symfony\Component\Mailer\Tests\Transport;
 
 use PHPUnit\Framework\TestCase;
+use Symfony\Bridge\Twig\Mime\BodyRenderer;
+use Symfony\Bridge\Twig\Mime\TemplatedEmail;
+use Symfony\Component\EventDispatcher\EventDispatcher;
 use Symfony\Component\Mailer\Envelope;
+use Symfony\Component\Mailer\EventListener\MessageListener;
 use Symfony\Component\Mailer\Exception\LogicException;
 use Symfony\Component\Mailer\Transport\NullTransport;
 use Symfony\Component\Mime\Address;
 use Symfony\Component\Mime\RawMessage;
+use Twig\Environment;
+use Twig\Loader\ArrayLoader;
 
 /**
  * @group time-sensitive
@@ -55,4 +61,21 @@ public function testSendingRawMessages()
         $transport = new NullTransport();
         $transport->send(new RawMessage('Some raw email message'));
     }
+
+    public function testNotRenderedTemplatedEmail()
+    {
+        $this->expectException(LogicException::class);
+
+        $transport = new NullTransport(new EventDispatcher());
+        $transport->send((new TemplatedEmail())->htmlTemplate('Some template'));
+    }
+
+    public function testRenderedTemplatedEmail()
+    {
+        $transport = new NullTransport($dispatcher = new EventDispatcher());
+        $dispatcher->addSubscriber(new MessageListener(null, new BodyRenderer(new Environment(new ArrayLoader(['tpl' => 'Some message'])))));
+
+        $sentMessage = $transport->send((new TemplatedEmail())->to('me@example.com')->from('me@example.com')->htmlTemplate('tpl'));
+        $this->assertMatchesRegularExpression('/Some message/', $sentMessage->getMessage()->toString());
+    }
 }
diff --git a/src/Symfony/Component/Mailer/Transport/AbstractTransport.php b/src/Symfony/Component/Mailer/Transport/AbstractTransport.php
@@ -14,12 +14,15 @@
 use Psr\EventDispatcher\EventDispatcherInterface;
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
+use Symfony\Bridge\Twig\Mime\TemplatedEmail;
 use Symfony\Component\Mailer\Envelope;
 use Symfony\Component\Mailer\Event\FailedMessageEvent;
 use Symfony\Component\Mailer\Event\MessageEvent;
 use Symfony\Component\Mailer\Event\SentMessageEvent;
+use Symfony\Component\Mailer\Exception\LogicException;
 use Symfony\Component\Mailer\SentMessage;
 use Symfony\Component\Mime\Address;
+use Symfony\Component\Mime\BodyRendererInterface;
 use Symfony\Component\Mime\RawMessage;
 
 /**
@@ -73,6 +76,10 @@ public function send(RawMessage $message, Envelope $envelope = null): ?SentMessa
             $envelope = $event->getEnvelope();
             $message = $event->getMessage();
 
+            if ($message instanceof TemplatedEmail && ($message->getTextTemplate() || $message->getHtmlTemplate())) {
+                throw new LogicException(sprintf('You must configure a "%s" when a "%s" instance has a text or HTML template set.', BodyRendererInterface::class, get_debug_type($message)));
+            }
+
             $sentMessage = new SentMessage($message, $envelope);
 
             try {
diff --git a/src/Symfony/Component/Mailer/composer.json b/src/Symfony/Component/Mailer/composer.json
@@ -27,7 +27,8 @@
     "require-dev": {
         "symfony/console": "^5.4|^6.0",
         "symfony/http-client-contracts": "^1.1|^2|^3",
-        "symfony/messenger": "^6.2"
+        "symfony/messenger": "^6.2",
+        "symfony/twig-bridge": "^6.2"
     },
     "conflict": {
         "symfony/http-kernel": "<5.4",
