Render email once

jderusse · jderusse · commit 186ea59180e6 · 2021-02-08T23:22:27.000+01:00
diff --git a/src/Symfony/Bridge/Twig/Mime/BodyRenderer.php b/src/Symfony/Bridge/Twig/Mime/BodyRenderer.php
@@ -46,6 +46,14 @@ public function render(Message $message): void
         }
 
         $messageContext = $message->getContext();
+
+        $previousRenderingKey = $messageContext[__CLASS__] ?? null;
+        unset($messageContext[__CLASS__]);
+        $currentRenderingKey = md5(serialize([$messageContext, $message->getTextTemplate(), $message->getHtmlTemplate()]));
+        if ($previousRenderingKey === $currentRenderingKey) {
+            return;
+        }
+
         if (isset($messageContext['email'])) {
             throw new InvalidArgumentException(sprintf('A "%s" context cannot have an "email" entry as this is a reserved variable.', \get_class($message)));
         }
@@ -66,6 +74,7 @@ public function render(Message $message): void
         if (!$message->getTextBody() && null !== $html = $message->getHtmlBody()) {
             $message->text($this->convertHtmlToText(\is_resource($html) ? stream_get_contents($html) : $html));
         }
+        $message->context($message->getContext() + [__CLASS__ => $currentRenderingKey]);
     }
 
     private function convertHtmlToText(string $html): string
diff --git a/src/Symfony/Bridge/Twig/Tests/Mime/BodyRendererTest.php b/src/Symfony/Bridge/Twig/Tests/Mime/BodyRendererTest.php
@@ -79,6 +79,27 @@ public function testRenderWithContextReservedEmailEntry()
         $this->prepareEmail('Text', '', ['email' => 'reserved!']);
     }
 
+    public function testRenderedOnce()
+    {
+        $twig = new Environment(new ArrayLoader([
+            'text' => 'Text',
+        ]));
+        $renderer = new BodyRenderer($twig);
+        $email = (new TemplatedEmail())
+            ->to('fabien@symfony.com')
+            ->from('helene@symfony.com')
+        ;
+        $email->textTemplate('text');
+
+        $renderer->render($email);
+        $this->assertEquals('Text', $email->getTextBody());
+
+        $email->text('reset');
+
+        $renderer->render($email);
+        $this->assertEquals('reset', $email->getTextBody());
+    }
+
     private function prepareEmail(?string $text, ?string $html, array $context = []): TemplatedEmail
     {
         $twig = new Environment(new ArrayLoader([

Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,14 @@ public function render(Message $message): void`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`$messageContext = $message->getContext();`
	`49`	`+`
	`50`	`+ $previousRenderingKey = $messageContext[__CLASS__] ?? null;`
	`51`	`+ unset($messageContext[__CLASS__]);`
	`52`	`+ $currentRenderingKey = md5(serialize([$messageContext, $message->getTextTemplate(), $message->getHtmlTemplate()]));`
	`53`	`+ if ($previousRenderingKey === $currentRenderingKey) {`
	`54`	`+ return;`
	`55`	`+ }`
	`56`	`+`
`49`	`57`	`if (isset($messageContext['email'])) {`
`50`	`58`	`throw new InvalidArgumentException(sprintf('A "%s" context cannot have an "email" entry as this is a reserved variable.', \get_class($message)));`
`51`	`59`	`}`
`@@ -66,6 +74,7 @@ public function render(Message $message): void`
`66`	`74`	`if (!$message->getTextBody() && null !== $html = $message->getHtmlBody()) {`
`67`	`75`	`$message->text($this->convertHtmlToText(\is_resource($html) ? stream_get_contents($html) : $html));`
`68`	`76`	`}`
	`77`	`+ $message->context($message->getContext() + [__CLASS__ => $currentRenderingKey]);`
`69`	`78`	`}`
`70`	`79`
`71`	`80`	`private function convertHtmlToText(string $html): string`